diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c108642..bd55b60 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -142,7 +142,13 @@ jobs: uses: actions/checkout@v2 - name: API sprawl check - run: ./cicd/scripts/hack/check_api_growth.sh + run: | + if ./cicd/scripts/hack/check_api_growth.sh; then + echo "API sprawl check passed" + else + echo "API sprawl check failed - please review for details" + exit 1 + fi - name: Setup system dependencies run: | diff --git a/anysdk/addressable.go b/anysdk/addressable.go index 88bfa9d..edfb5e4 100644 --- a/anysdk/addressable.go +++ b/anysdk/addressable.go @@ -68,6 +68,15 @@ func newAddressableServerVariable(name string, s Schema, isRequired bool) Addres } } +func newAddressableContextVariable(name string, s Schema, isRequired bool) Addressable { + return &namedSchema{ + s: s, + name: name, + location: LocationContext, + isRequired: isRequired, + } +} + type Addressable interface { ConditionIsValid(lhs string, rhs interface{}) bool GetLocation() string diff --git a/anysdk/client.go b/anysdk/client.go index 73e8971..0742173 100644 --- a/anysdk/client.go +++ b/anysdk/client.go @@ -13,6 +13,7 @@ import ( "github.com/stackql/any-sdk/pkg/client" "github.com/stackql/any-sdk/pkg/dto" "github.com/stackql/any-sdk/pkg/internaldto" + "github.com/stackql/any-sdk/pkg/latetranslator" "github.com/stackql/any-sdk/pkg/netutils" "github.com/stackql/any-sdk/pkg/requesttranslate" ) @@ -24,12 +25,14 @@ var ( ) type anySdkHttpClient struct { - client *http.Client + client *http.Client + lateTranslator latetranslator.LateTranslator } func newAnySdkHttpClient(client *http.Client) client.AnySdkClient { return &anySdkHttpClient{ - client: client, + client: client, + lateTranslator: latetranslator.NewNaiveLateTranslator(), } } @@ -120,7 +123,11 @@ func (hc *anySdkHttpClient) Do(designation client.AnySdkDesignation, argList cli if !isHttpRequest { return nil, fmt.Errorf("could not cast first argument to http.Request") } - httpResponse, httpResponseErr := hc.client.Do(httpReq) + translatedRequest, translationErr := hc.lateTranslator.Translate(httpReq) + if translationErr != nil { + return nil, translationErr + } + httpResponse, httpResponseErr := hc.client.Do(translatedRequest) if httpResponseErr != nil { return nil, httpResponseErr } @@ -129,19 +136,25 @@ func (hc *anySdkHttpClient) Do(designation client.AnySdkDesignation, argList cli } type anySdkHTTPClientConfigurator struct { - runtimeCtx dto.RuntimeCtx - authUtil auth_util.AuthUtility - providerName string + runtimeCtx dto.RuntimeCtx + authUtil auth_util.AuthUtility + providerName string + defaultClient *http.Client } func NewAnySdkClientConfigurator( rtCtx dto.RuntimeCtx, provName string, + defaultClient *http.Client, ) client.AnySdkClientConfigurator { + if defaultClient == nil { + defaultClient = http.DefaultClient + } return &anySdkHTTPClientConfigurator{ - runtimeCtx: rtCtx, - authUtil: auth_util.NewAuthUtility(), - providerName: provName, + runtimeCtx: rtCtx, + authUtil: auth_util.NewAuthUtility(defaultClient), + providerName: provName, + defaultClient: defaultClient, } } @@ -246,7 +259,7 @@ func (cc *anySdkHTTPClientConfigurator) Auth( } return newAnySdkHttpClient(httpClient), nil case dto.AuthNullStr: - httpClient := netutils.GetHTTPClient(cc.runtimeCtx, http.DefaultClient) + httpClient := netutils.GetHTTPClient(cc.runtimeCtx, cc.defaultClient) return newAnySdkHttpClient(httpClient), nil } return nil, fmt.Errorf("could not infer auth type") diff --git a/anysdk/client_test.go b/anysdk/client_test.go index 8fcf55a..18f02c8 100644 --- a/anysdk/client_test.go +++ b/anysdk/client_test.go @@ -1,11 +1,18 @@ package anysdk_test import ( + "context" + "io" + "net" + "net/http" + "net/http/httptest" "os" "path" "testing" + "github.com/sirupsen/logrus" . "github.com/stackql/any-sdk/anysdk" + "github.com/stackql/any-sdk/pkg/dto" "github.com/stackql/any-sdk/pkg/fileutil" "gotest.tools/assert" @@ -76,3 +83,493 @@ func TestLocalTemplateClient(t *testing.T) { } t.Logf("stdout: %s", stdOut.String()) } + +func TestAwsS3BucketABACRequestBodyOverride(t *testing.T) { + + vr := "v0.1.0" + pb, err := os.ReadFile("./testdata/registry/src/aws/" + vr + "/provider.yaml") + if err != nil { + t.Fatalf("Test failed: could not read provider doc, error: %v", err) + } + prov, provErr := LoadProviderDocFromBytes(pb) + if provErr != nil { + t.Fatalf("Test failed: could not load provider doc, error: %v", provErr) + } + svc, err := LoadProviderAndServiceFromPaths( + "./testdata/registry/src/aws/"+vr+"/provider.yaml", + "./testdata/registry/src/aws/"+vr+"/services/s3.yaml", + ) + if err != nil { + t.Fatalf("Test failed: %v", err) + } + rsc, rscErr := svc.GetResource("bucket_abac") + if rscErr != nil { + t.Fatalf("Test failed: could not locate resource bucket_abac, error: %v", rscErr) + } + method, methodErr := rsc.FindMethod("put_bucket_abac") + if methodErr != nil { + t.Fatalf("Test failed: could not locate method put_bucket_abac, error: %v", methodErr) + } + expectedRequest, hasRequest := method.GetRequest() + if !hasRequest || expectedRequest == nil { + t.Fatalf("Test failed: expected request is nil") + } + + transform, hasTransform := expectedRequest.GetTransform() + if !hasTransform || transform == nil { + t.Fatalf("Test failed: expected transform is nil") + } + schema := expectedRequest.GetSchema() + + schemaDescription := schema.GetDescription() + + assert.Equal(t, schemaDescription, "A convenience for presentation") + + assert.Assert(t, schema != nil, "expected schema to be non-nil") + props, _ := schema.GetProperties() + assert.Assert(t, props != nil, "expected schema properties to be non-nil") + _, hasLineItem := props["line_items"] + _, hasStatus := props["status"] + assert.Assert(t, hasLineItem, "expected schema to have 'line_items' property") + assert.Assert(t, hasStatus, "expected schema to have 'status' property") + + finalSchema := expectedRequest.GetFinalSchema() + assert.Assert(t, finalSchema != nil, "expected final schema to be non-nil") + finalProps, _ := finalSchema.GetProperties() + assert.Assert(t, len(finalProps) != 0, "expected final schema properties to be non-empty") + _, finalHasStatus := finalProps["Status"] + assert.Assert(t, finalHasStatus, "expected final schema to have 'Status' property") + + finalDescription := finalSchema.GetDescription() + assert.Equal(t, finalDescription, "The ABAC status of the general purpose bucket. When ABAC is enabled for the general purpose bucket, you can use tags to manage access to the general purpose buckets as well as for cost tracking purposes. When ABAC is disabled for the general purpose buckets, you can only use tags for cost tracking purposes. For more information, see [Using tags with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html).") + + // Body media type should inherit from final schema and not override schema + assert.Equal(t, expectedRequest.GetBodyMediaType(), "application/xml") + + assert.Equal(t, svc.GetName(), "s3") + + tlsServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + defer r.Body.Close() + io.Copy(io.Discard, r.Body) + w.WriteHeader(http.StatusOK) + })) + t.Cleanup(tlsServer.Close) + + baseTransport := tlsServer.Client().Transport.(*http.Transport) + dummyClient := &http.Client{ + Transport: &http.Transport{ + TLSClientConfig: baseTransport.TLSClientConfig, + DisableKeepAlives: true, + DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) { + return net.Dial("tcp", tlsServer.Listener.Addr().String()) + }, + }, + } + + authCtx := dto.GetAuthCtx([]string{}, "./testdata/dummy_credentials/dummy-sa-key.json", "null_auth") + + configurator := NewAnySdkClientConfigurator( + dto.RuntimeCtx{ + AllowInsecure: true, + }, + "aws", + dummyClient, + ) + // client, clientErr := configurator.Auth( + // authCtx, + // dto.AuthNullStr, + // false, + // ) + // if clientErr != nil { + // t.Fatalf("Test failed: could not create client, error: %v", clientErr) + // } + // if client == nil { + // t.Fatalf("Test failed: client is nil") + // } + httpPreparator := NewHTTPPreparator( + prov, + svc, + method, + map[int]map[string]interface{}{ + 0: { + "Bucket": "my-test-bucket", + "Status": "Enabled", + }, + }, + nil, + nil, + logrus.StandardLogger(), + ) + armoury, armouryErr := httpPreparator.BuildHTTPRequestCtx(NewHTTPPreparatorConfig(false)) + if armouryErr != nil { + t.Fatalf("Test failed: could not build HTTP preparator armoury, error: %v", armouryErr) + } + reqParams := armoury.GetRequestParams() + if len(reqParams) < 1 { + t.Fatalf("Test failed: no request parameters found") + } + + for _, v := range reqParams { + + argList := v.GetArgList() + + // response, apiErr := CallFromSignature( + // cc, payload.rtCtx, authCtx, authCtx.Type, false, os.Stderr, prov, anysdk.NewAnySdkOpStoreDesignation(opStore), argList) + + response, apiErr := CallFromSignature( + configurator, + dto.RuntimeCtx{ + AllowInsecure: true, + }, + authCtx, + authCtx.Type, + false, + nil, + prov, + NewAnySdkOpStoreDesignation(method), + argList, // TODO: abstract + ) + if apiErr != nil { + t.Fatalf("Test failed: API call error: %v", apiErr) + } + if response.IsErroneous() { + t.Fatalf("Test failed: API call returned erroneous response") + } + t.Logf("Test passed: received response: %+v", response) + } + +} + +func TestAwsS3BucketAclsGet(t *testing.T) { + + vr := "v0.1.0" + pb, err := os.ReadFile("./testdata/registry/src/aws/" + vr + "/provider.yaml") + if err != nil { + t.Fatalf("Test failed: could not read provider doc, error: %v", err) + } + prov, provErr := LoadProviderDocFromBytes(pb) + if provErr != nil { + t.Fatalf("Test failed: could not load provider doc, error: %v", provErr) + } + svc, err := LoadProviderAndServiceFromPaths( + "./testdata/registry/src/aws/"+vr+"/provider.yaml", + "./testdata/registry/src/aws/"+vr+"/services/s3.yaml", + ) + if err != nil { + t.Fatalf("Test failed: %v", err) + } + rsc, rscErr := svc.GetResource("bucket_acls") + if rscErr != nil { + t.Fatalf("Test failed: could not locate resource bucket_acls, error: %v", rscErr) + } + method, methodErr := rsc.FindMethod("get_bucket_acl") + if methodErr != nil { + t.Fatalf("Test failed: could not locate method get_bucket_acl, error: %v", methodErr) + } + + assert.Equal(t, svc.GetName(), "s3") + + expectedHost := "my-test-bucket.s3-ap-southeast-2.amazonaws.com" + + tlsServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + defer r.Body.Close() + io.Copy(io.Discard, r.Body) + assert.Equal(t, r.Host, expectedHost, "expected host does not match actual host") + w.WriteHeader(http.StatusOK) + })) + t.Cleanup(tlsServer.Close) + + baseTransport := tlsServer.Client().Transport.(*http.Transport) + dummyClient := &http.Client{ + Transport: &http.Transport{ + TLSClientConfig: baseTransport.TLSClientConfig, + DisableKeepAlives: true, + DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) { + return net.Dial("tcp", tlsServer.Listener.Addr().String()) + }, + }, + } + + authCtx := dto.GetAuthCtx([]string{}, "./testdata/dummy_credentials/dummy-sa-key.json", "null_auth") + + configurator := NewAnySdkClientConfigurator( + dto.RuntimeCtx{ + AllowInsecure: true, + }, + "aws", + dummyClient, + ) + httpPreparator := NewHTTPPreparator( + prov, + svc, + method, + map[int]map[string]interface{}{ + 0: { + "Bucket": "my-test-bucket", + "created_date": "2024-01-01T00:00:00Z", + "region": "ap-southeast-2", + }, + }, + nil, + nil, + logrus.StandardLogger(), + ) + armoury, armouryErr := httpPreparator.BuildHTTPRequestCtx(NewHTTPPreparatorConfig(false)) + if armouryErr != nil { + t.Fatalf("Test failed: could not build HTTP preparator armoury, error: %v", armouryErr) + } + reqParams := armoury.GetRequestParams() + if len(reqParams) < 1 { + t.Fatalf("Test failed: no request parameters found") + } + + for _, v := range reqParams { + + argList := v.GetArgList() + + response, apiErr := CallFromSignature( + configurator, + dto.RuntimeCtx{ + AllowInsecure: true, + }, + authCtx, + authCtx.Type, + false, + nil, + prov, + NewAnySdkOpStoreDesignation(method), + argList, // TODO: abstract + ) + if apiErr != nil { + t.Fatalf("Test failed: API call error: %v", apiErr) + } + if response.IsErroneous() { + t.Fatalf("Test failed: API call returned erroneous response") + } + t.Logf("Test passed: received response: %+v", response) + } + +} + +func TestLegacyPathAwsS3BucketAclsGet(t *testing.T) { + + vr := "v0.1.0" + pb, err := os.ReadFile("./testdata/registry/src/aws/" + vr + "/provider.yaml") + if err != nil { + t.Fatalf("Test failed: could not read provider doc, error: %v", err) + } + prov, provErr := LoadProviderDocFromBytes(pb) + if provErr != nil { + t.Fatalf("Test failed: could not load provider doc, error: %v", provErr) + } + svc, err := LoadProviderAndServiceFromPaths( + "./testdata/registry/src/aws/"+vr+"/provider.yaml", + "./testdata/registry/src/aws/"+vr+"/services/s3.yaml", + ) + if err != nil { + t.Fatalf("Test failed: %v", err) + } + rsc, rscErr := svc.GetResource("bucket_acls") + if rscErr != nil { + t.Fatalf("Test failed: could not locate resource bucket_acls, error: %v", rscErr) + } + method, methodErr := rsc.FindMethod("get_bucket_acl") + if methodErr != nil { + t.Fatalf("Test failed: could not locate method get_bucket_acl, error: %v", methodErr) + } + + assert.Equal(t, svc.GetName(), "s3") + + expectedHost := "s3.ap-northeast-1.amazonaws.com" + + expectedPath := "/my.test-bucket" + + tlsServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + defer r.Body.Close() + io.Copy(io.Discard, r.Body) + assert.Equal(t, r.Host, expectedHost, "expected host does not match actual host") + assert.Equal(t, r.URL.Path, expectedPath, "expected path does not match actual path") + w.WriteHeader(http.StatusOK) + })) + t.Cleanup(tlsServer.Close) + + baseTransport := tlsServer.Client().Transport.(*http.Transport) + dummyClient := &http.Client{ + Transport: &http.Transport{ + TLSClientConfig: baseTransport.TLSClientConfig, + DisableKeepAlives: true, + DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) { + return net.Dial("tcp", tlsServer.Listener.Addr().String()) + }, + }, + } + + authCtx := dto.GetAuthCtx([]string{}, "./testdata/dummy_credentials/dummy-sa-key.json", "null_auth") + + configurator := NewAnySdkClientConfigurator( + dto.RuntimeCtx{ + AllowInsecure: true, + }, + "aws", + dummyClient, + ) + httpPreparator := NewHTTPPreparator( + prov, + svc, + method, + map[int]map[string]interface{}{ + 0: { + "Bucket": "my.test-bucket", + "created_date": "2016-01-01T00:00:00Z", + "region": "ap-northeast-1", + }, + }, + nil, + nil, + logrus.StandardLogger(), + ) + armoury, armouryErr := httpPreparator.BuildHTTPRequestCtx(NewHTTPPreparatorConfig(false)) + if armouryErr != nil { + t.Fatalf("Test failed: could not build HTTP preparator armoury, error: %v", armouryErr) + } + reqParams := armoury.GetRequestParams() + if len(reqParams) < 1 { + t.Fatalf("Test failed: no request parameters found") + } + + for _, v := range reqParams { + + argList := v.GetArgList() + + response, apiErr := CallFromSignature( + configurator, + dto.RuntimeCtx{ + AllowInsecure: true, + }, + authCtx, + authCtx.Type, + false, + nil, + prov, + NewAnySdkOpStoreDesignation(method), + argList, // TODO: abstract + ) + if apiErr != nil { + t.Fatalf("Test failed: API call error: %v", apiErr) + } + if response.IsErroneous() { + t.Fatalf("Test failed: API call returned erroneous response") + } + t.Logf("Test passed: received response: %+v", response) + } + +} + +func TestK8sHostMatching(t *testing.T) { + + vr := "v0.1.0" + pb, err := os.ReadFile("./testdata/registry/src/k8s/" + vr + "/provider.yaml") + if err != nil { + t.Fatalf("Test failed: could not read provider doc, error: %v", err) + } + prov, provErr := LoadProviderDocFromBytes(pb) + if provErr != nil { + t.Fatalf("Test failed: could not load provider doc, error: %v", provErr) + } + svc, err := LoadProviderAndServiceFromPaths( + "./testdata/registry/src/k8s/"+vr+"/provider.yaml", + "./testdata/registry/src/k8s/"+vr+"/services/core_v1.yaml", + ) + if err != nil { + t.Fatalf("Test failed: %v", err) + } + rsc, rscErr := svc.GetResource("apis") + if rscErr != nil { + t.Fatalf("Test failed: could not locate resource apis, error: %v", rscErr) + } + method, methodErr := rsc.FindMethod("getAPIVersions") + if methodErr != nil { + t.Fatalf("Test failed: could not locate method getAPIVersions, error: %v", methodErr) + } + + assert.Equal(t, svc.GetName(), "Kubernetes - core_v1") + + // expectedHost := "stackql-trial-bucket-02.s3-us-east-1.amazonaws.com" + + tlsServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + defer r.Body.Close() + io.Copy(io.Discard, r.Body) + // assert.Equal(t, r.Host, expectedHost, "expected host does not match actual host") + w.WriteHeader(http.StatusOK) + })) + t.Cleanup(tlsServer.Close) + + baseTransport := tlsServer.Client().Transport.(*http.Transport) + dummyClient := &http.Client{ + Transport: &http.Transport{ + TLSClientConfig: baseTransport.TLSClientConfig, + DisableKeepAlives: true, + DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) { + return net.Dial("tcp", tlsServer.Listener.Addr().String()) + }, + }, + } + + authCtx := dto.GetAuthCtx([]string{}, "./testdata/dummy_credentials/dummy-sa-key.json", "null_auth") + + configurator := NewAnySdkClientConfigurator( + dto.RuntimeCtx{ + AllowInsecure: true, + }, + "aws", + dummyClient, + ) + httpPreparator := NewHTTPPreparator( + prov, + svc, + method, + map[int]map[string]interface{}{ + 0: { + "cluster_addr": "my.test-bucket", + }, + }, + nil, + nil, + logrus.StandardLogger(), + ) + armoury, armouryErr := httpPreparator.BuildHTTPRequestCtx(NewHTTPPreparatorConfig(false)) + if armouryErr != nil { + t.Fatalf("Test failed: could not build HTTP preparator armoury, error: %v", armouryErr) + } + reqParams := armoury.GetRequestParams() + if len(reqParams) < 1 { + t.Fatalf("Test failed: no request parameters found") + } + + for _, v := range reqParams { + + argList := v.GetArgList() + + response, apiErr := CallFromSignature( + configurator, + dto.RuntimeCtx{ + AllowInsecure: true, + }, + authCtx, + authCtx.Type, + false, + nil, + prov, + NewAnySdkOpStoreDesignation(method), + argList, // TODO: abstract + ) + if apiErr != nil { + t.Fatalf("Test failed: API call error: %v", apiErr) + } + if response.IsErroneous() { + t.Fatalf("Test failed: API call returned erroneous response") + } + t.Logf("Test passed: received response: %+v", response) + } + +} diff --git a/anysdk/const.go b/anysdk/const.go index ac9a01b..3839a31 100644 --- a/anysdk/const.go +++ b/anysdk/const.go @@ -21,6 +21,7 @@ const ( LocationHeader string = "header" LocationCookie string = "cookie" LocationServer string = "server" + LocationContext string = "context" ) const ( diff --git a/anysdk/http.go b/anysdk/http.go index f2147b7..5dbb3ec 100644 --- a/anysdk/http.go +++ b/anysdk/http.go @@ -153,6 +153,7 @@ type HttpParameters interface { GetParameter(paramName, paramIn string) (ParameterBinding, bool) GetRemainingQueryParamsFlatMap(keysRemaining map[string]interface{}) (map[string]interface{}, error) GetServerParameterFlatMap() (map[string]interface{}, error) + GetContextParameterFlatMap() (map[string]interface{}, error) SetResponseBodyParam(key string, val interface{}) SetServerParam(key string, svc OpenAPIService, val interface{}) SetRequestBodyParam(key string, val interface{}) @@ -162,31 +163,33 @@ type HttpParameters interface { } type standardHttpParameters struct { - opStore StandardOperationStore - CookieParams ParamMap - HeaderParams ParamMap - PathParams ParamMap - QueryParams ParamMap - RequestBody BodyMap - ResponseBody BodyMap - ServerParams ParamMap - InlineParams ParamMap - Unassigned ParamMap - Region EncodableString + opStore StandardOperationStore + CookieParams ParamMap + HeaderParams ParamMap + PathParams ParamMap + QueryParams ParamMap + RequestBody BodyMap + ResponseBody BodyMap + ServerParams ParamMap + ContextParams ParamMap + InlineParams ParamMap + Unassigned ParamMap + Region EncodableString } func NewHttpParameters(method StandardOperationStore) HttpParameters { return &standardHttpParameters{ - opStore: method, - CookieParams: make(ParamMap), - HeaderParams: make(ParamMap), - PathParams: make(ParamMap), - QueryParams: make(ParamMap), - RequestBody: make(BodyMap), - ResponseBody: make(BodyMap), - ServerParams: make(ParamMap), - InlineParams: make(ParamMap), - Unassigned: make(ParamMap), + opStore: method, + CookieParams: make(ParamMap), + HeaderParams: make(ParamMap), + PathParams: make(ParamMap), + QueryParams: make(ParamMap), + RequestBody: make(BodyMap), + ResponseBody: make(BodyMap), + ServerParams: make(ParamMap), + ContextParams: make(ParamMap), + InlineParams: make(ParamMap), + Unassigned: make(ParamMap), } } @@ -276,6 +279,10 @@ func (hp *standardHttpParameters) StoreParameter(param Addressable, val interfac hp.ServerParams[param.GetName()] = NewParameterBinding(param, val) return } + if param.GetLocation() == "context" { + hp.ContextParams[param.GetName()] = NewParameterBinding(param, val) + return + } if param.GetLocation() == "inline" { hp.InlineParams[param.GetName()] = NewParameterBinding(param, val) return @@ -318,6 +325,13 @@ func (hp *standardHttpParameters) GetParameter(paramName, paramIn string) (Param } return rv, true } + if paramIn == "context" { + rv, ok := hp.ContextParams[paramName] + if !ok { + return nil, false + } + return rv, true + } return nil, false } @@ -369,6 +383,12 @@ func (hp *standardHttpParameters) ToFlatMap() (map[string]interface{}, error) { return nil, err } } + for k, v := range hp.ContextParams { + err := hp.updateStuff(k, v, rv, visited) + if err != nil { + return nil, err + } + } for k, v := range hp.PathParams { err := hp.updateStuff(k, v, rv, visited) if err != nil { @@ -418,6 +438,18 @@ func (hp *standardHttpParameters) GetServerParameterFlatMap() (map[string]interf return rv, nil } +func (hp *standardHttpParameters) GetContextParameterFlatMap() (map[string]interface{}, error) { + rv := make(map[string]interface{}) + visited := make(map[string]struct{}) + for k, v := range hp.ContextParams { + err := hp.updateStuff(k, v, rv, visited) + if err != nil { + return nil, err + } + } + return rv, nil +} + func (hp *standardHttpParameters) GetInlineParameterFlatMap() (map[string]interface{}, error) { rv := make(map[string]interface{}) visited := make(map[string]struct{}) diff --git a/anysdk/operation_store.go b/anysdk/operation_store.go index 1933a21..0563b7f 100644 --- a/anysdk/operation_store.go +++ b/anysdk/operation_store.go @@ -115,6 +115,7 @@ type OperationStore interface { ShouldBeSelectable() bool GetServiceNameForProvider() string getServiceNameForProvider() string + getContextVariables() map[string]Addressable } type StandardOperationStore interface { @@ -823,6 +824,17 @@ func (m *standardOpenAPIOperationStore) GetRequiredParameters() map[string]Addre return m.getRequiredParameters() } +func (m *standardOpenAPIOperationStore) getContextVariables() map[string]Addressable { + params := make(map[string]Addressable) + allParams := m.getNonBodyParameters() + for k, v := range allParams { + if v.GetLocation() == LocationContext { + params[k] = v + } + } + return params +} + func (m *standardOpenAPIOperationStore) getRequestBodyAttributes() (map[string]Addressable, error) { s, err := m.getRequestBodySchema() if err != nil { diff --git a/anysdk/operation_store_test.go b/anysdk/operation_store_test.go index 4d68cd8..0ee1a16 100644 --- a/anysdk/operation_store_test.go +++ b/anysdk/operation_store_test.go @@ -579,6 +579,36 @@ func TestXMLRequestBody(t *testing.T) { } +// Test the new context parameter handling in requests +// using s3 bucket object list as example +func TestContextVar(t *testing.T) { + + b, err := GetServiceDocBytes("./testdata/registry/src/aws/v0.1.0/services/s3.yaml", ".") + assert.NilError(t, err) + + l := newLoader() + + svc, err := l.loadFromBytes(b) + + assert.NilError(t, err) + assert.Assert(t, svc != nil) + + // assert.Equal(t, svc.GetName(), "ec2") + + rsc, err := svc.GetResource("bucket_acls") + assert.NilError(t, err) + assert.Assert(t, rsc != nil) + + ops, _, ok := rsc.GetFirstNamespaceMethodMatchFromSQLVerb("select", map[string]any{ + "created_date": "2023-01-01T00:00:00Z", + "Bucket": "my-test-bucket", + }) + assert.Assert(t, ok) + // assert.Assert(t, st != "") + assert.Assert(t, ops != nil) + +} + func TestJSONRequestBody(t *testing.T) { b, err := GetServiceDocBytes("./testdata/registry/src/googleapis.com/v0.1.2/services/storage-v1.yaml", ".") diff --git a/anysdk/params.go b/anysdk/params.go index c5910c4..ffff8ca 100644 --- a/anysdk/params.go +++ b/anysdk/params.go @@ -101,5 +101,8 @@ func (p parameters) GetParameter(key string) (Addressable, bool) { if param, ok := p.getParameterFromInSubset(key, openapi3.ParameterInCookie); ok { return param, true } + if param, ok := p.getParameterFromInSubset(key, "context"); ok { + return param, true + } return nil, false } diff --git a/anysdk/request.go b/anysdk/request.go index 76b769f..8f322a9 100644 --- a/anysdk/request.go +++ b/anysdk/request.go @@ -10,6 +10,7 @@ import ( "github.com/sirupsen/logrus" "github.com/stackql/any-sdk/pkg/client" + "github.com/stackql/any-sdk/pkg/dto" "github.com/stackql/any-sdk/pkg/stream_transform" "github.com/stackql/any-sdk/pkg/streaming" ) @@ -210,6 +211,7 @@ func (pr *standardHTTPPreparator) BuildHTTPRequestCtx(cfg HTTPPreparatorConfig) func awsContextHousekeeping( ctx context.Context, method OperationStore, + contextParams map[string]interface{}, parameters map[string]interface{}, ) context.Context { svcName := method.getServiceNameForProvider() @@ -219,6 +221,10 @@ func awsContextHousekeeping( ctx = context.WithValue(ctx, "region", regionStr) //nolint:revive,staticcheck // TODO: add custom context type } } + for k, v := range contextParams { + contextKey := dto.ContextKey(fmt.Sprintf("%s%s", dto.ContextPrefixStackqlRequest, k)) + ctx = context.WithValue(ctx, contextKey, v) //nolint:revive,staticcheck // TODO: add custom context type + } return ctx } @@ -237,7 +243,11 @@ func getRequest( return nil, err } request := validationParams.Request - ctx := awsContextHousekeeping(request.Context(), method, params) + contextParams, err := httpParams.GetContextParameterFlatMap() + if err != nil { + return nil, err + } + ctx := awsContextHousekeeping(request.Context(), method, contextParams, params) request = request.WithContext(ctx) return request, nil } diff --git a/anysdk/testdata/dummy_credentials/dummy-sa-key.json b/anysdk/testdata/dummy_credentials/dummy-sa-key.json new file mode 100644 index 0000000..bc52a71 --- /dev/null +++ b/anysdk/testdata/dummy_credentials/dummy-sa-key.json @@ -0,0 +1,12 @@ +{ + "type": "service_account", + "project_id": "silly-project-01", + "private_key_id": "silly-key-id", + "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAsTfIs92qRg+srgviU9EHJfcgjn/38QFJTa0xYPSNSLSj4hXw\niyPyZ4ih6nIfW2NP4tvwK3piQrmHx/pQesrp5exKF3b97tf+Cvf9gM+i/3wJGhEb\nE24Py91+/5aXf6TfkuhNutZ3v5qzHYRtWcr3AXcD2WAThF6hxmvQTFTYqcyUb6vl\nt7evG6OleifU5rAKmD8Odk8Hs1skwAmlWjWT1uouWVegFv53a8eUilNiBSnYy/PA\nYchL2fGI8Os+CFyju+ns6dG9H7bAOywvZZaTzlVNvJ42gop03l5xzEwHkUKlcukg\nhyDtP5FTeD5liYUJ/Xqq6Xn6Rjck/AgTwqYePwIDAQABAoIBAQCdS08X3oJ4hwcU\nwDWVgW1f1DYQZSLzxdmDWVr/nHAefT8Mt752MWTBYnOcfMi6O663Q9GrNYgrgzMy\nW0m9g4cRbaXhp9sBeLLil3RpNWKOc1A807v9he39W86SGt7DC9rpMMl1MVC+PxgF\n9fl8/no40aMX+H+6OKhMTntmlNRt+E1WUIGBk9cScb37e+oAStfS0Z6c8kQ9CkOZ\nHwydCtq8gQDpkRYMM3m7j3j9mr2Rma1o8xcBbgbomYn6y2xPQf1B4rs9fb8txngv\nGxA+QSRSXNMQmQFLmoc6d3XHFZQ5LX7atRhHsnt4blb8GNqJg8FsTFED68cWKoNp\n0Lk7c/9xAoGBAOLplpGdg3ezAMtFR5gAi8pV9vGJairJsuBij22uK0rItNkaff4G\nYyciybCKJZfXTcOzYq/CGh8KwxhN6RECmHm+bHfnxFDdHXS8e0bs8oTlR7w3yHs4\nhrplBMCwyAgSsma7s8aNBfdkDlPMxYmvytWdHf3T4mj6C5LGlFzpTLmpAoGBAMfv\naHNPLCoJjvQmNlzboN0sLZYhRl2YgW86mM0MoW7pO4cY4On5twbdFD7AtHIKF4j5\nomsMVfTDvKZ+jbHoJFuvvhozq0T/LpEx5b6d27A4pfacmG0zNaLaopoDYQ6wBvYD\n4L9OScFRrtf/X3ZgLzsmNpEVlqyUU2tbCAJVa5mnAoGBAI7ODVmVNPD3Mc+7ySPr\nbA6p7WDzZ2KIT9ARl0yiqVJGYDKmDpb5NBukNCSrvJ8D/EfmtHwCf2f74O6B0eVH\nqegspJ0NuqpdjjUyja8EXliu52eX/880su3Jt6UBXNJf2fD3vlt90zxvtuicXdGa\nVd/8IqzlVX9VpkT4PtT+arAJAoGAZkmknYG+7Y7QVTaLj3xJ0327oNhLQK06YyaO\ncDFrEew/KUHgJ7Q7IEbRCb3bU5C4M7rLjorUGxJdHK0YXxGOMF48GvmeQQFw2JW3\nnYrzjzecKQw6q3uMkFHc6ICcEkCafxjCzf0GnOHmWtlrBIv2/gLx3c42tPp5py3+\nbfs3vncCgYEA0x6tF67q3zt+daUMUox6LimkkDJLsfqnmKjvHFAhKQaqOObWaody\nfGOzlf/KLX15uicYWeCwRrs03OjBfk6LEtVddsZOrjJEp8+6gA8KEf58MJhNuRVj\no3qSe9po1TMj0/hvzd32klXslpqQjXFjm9U3lAxfcRdgWsG7SciOAAs=\n-----END RSA PRIVATE KEY-----\n", + "client_email": "silly-sa@silly-project-01.iam.gserviceaccount.com", + "client_id": "11", + "auth_uri": "https://accounts.google.com/o/oauth2/auth", + "token_uri": "https://oauth2.googleapis.com/token", + "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", + "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/silly-sa%40silly-project-01.iam.gserviceaccount.com" +} \ No newline at end of file diff --git a/anysdk/testdata/registry/src/aws/v0.1.0/services/s3.yaml b/anysdk/testdata/registry/src/aws/v0.1.0/services/s3.yaml index 5fb2eeb..3ab352e 100644 --- a/anysdk/testdata/registry/src/aws/v0.1.0/services/s3.yaml +++ b/anysdk/testdata/registry/src/aws/v0.1.0/services/s3.yaml @@ -42,23290 +42,13827 @@ servers: - me-south-1 default: us-east-1 paths: - /{Bucket}/{Key+}?x-id=AbortMultipartUpload: - delete: - operationId: AbortMultipartUpload - description: "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.\n\nTo verify that all parts have been removed and\ - \ prevent getting charged for the part storage, you should call the [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\ - \ API operation and ensure that the parts list is empty.\n\n * **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. To delete these in-progress multipart uploads,\ - \ use the `ListMultipartUploads` operation to list the in-progress multipart\ - \ uploads in the bucket and use the `AbortMultipartUpload` operation to abort\ - \ all the in-progress multipart uploads. \n\n * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- For information about permissions required to use\ - \ the multipart upload, see [Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nHTTP Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host\ - \ header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `AbortMultipartUpload`:\n\n * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." + /?abac: + servers: + - url: 'https://{Bucket}.s3-{region}.amazonaws.com' + variables: + Bucket: + default: stackql-trial-bucket-02 + region: + default: us-east-1 + get: + operationId: GetBucketAbac + description: |- + Returns the attribute-based access control (ABAC) property of the general purpose bucket. If ABAC is enabled on your bucket, you can use tags on the bucket for access control. For more information, see [Enabling ABAC in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html). parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: uploadId - in: query - required: true - schema: - $ref: '#/components/schemas/MultipartUploadId' - - name: x-amz-request-payer + - name: x-amz-content-sha256 in: header required: false schema: - $ref: '#/components/schemas/RequestPayer' + type: string + default: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - name: x-amz-expected-bucket-owner in: header required: false schema: $ref: '#/components/schemas/AccountId' - - name: x-amz-if-match-initiated-time - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatchInitiatedTime' responses: - '204': + '200': description: Success content: text/xml: schema: - $ref: '#/components/schemas/AbortMultipartUploadOutput' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchUpload' - description: |- - The specified multipart upload does not exist. - /{Bucket}/{Key+}: - post: - operationId: CompleteMultipartUpload - description: "Completes a multipart upload by assembling previously uploaded\ - \ parts.\n\nYou first initiate the multipart upload and then upload all parts\ - \ using the [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\ - \ operation or the [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)\ - \ 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.\n\nThe 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).\n\nNote that if `CompleteMultipartUpload` fails, applications\ - \ should be prepared to retry any failed requests (including 500 error responses).\ - \ For more information, see [Amazon S3 Error Best Practices](https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html).\n\ - \nYou 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.\n\ - \nFor more information about multipart uploads, see [Uploading Objects Using\ - \ Multipart Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- For information about permissions required to use\ - \ the multipart upload API, see [Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf you provide an [additional checksum\ - \ value](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html)\ - \ in your `MultipartUpload` requests and the object is encrypted with Key\ - \ Management Service, you must have permission to use the `kms:Decrypt` action\ - \ for the `CompleteMultipartUpload` request to succeed.\n\n * **Directory\ - \ bucket permissions** \\- To grant access to this API operation on a directory\ - \ bucket, we recommend that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nIf the object is encrypted with SSE-KMS, you must also have the `kms:GenerateDataKey`\ - \ and `kms:Decrypt` permissions in IAM identity-based policies and KMS key\ - \ policies for the KMS key.\n\nSpecial errors\n\n \n\n * Error Code: `EntityTooSmall`\n\ - \n * 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.\n\ - \n * HTTP Status Code: 400 Bad Request\n\n * Error Code: `InvalidPart`\n\ - \n * 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.\n\n * HTTP Status Code: 400 Bad Request\n\ - \n * Error Code: `InvalidPartOrder`\n\n * Description: The list of parts\ - \ was not in ascending order. The parts list must be specified in order by\ - \ part number.\n\n * HTTP Status Code: 400 Bad Request\n\n * Error Code:\ - \ `NoSuchUpload`\n\n * Description: The specified multipart upload does\ - \ not exist. The upload ID might be invalid, or the multipart upload might\ - \ have been aborted or completed.\n\n * HTTP Status Code: 404 Not Found\n\ - \nHTTP Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host\ - \ header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `CompleteMultipartUpload`:\n\n \ - \ * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." + $ref: '#/components/schemas/GetBucketAbacOutput' + put: + operationId: PutBucketAbac + description: |- + Sets the attribute-based access control (ABAC) property of the general purpose bucket. You must have `s3:PutBucketABAC` permission to perform this action. When you enable ABAC, you can use tags for access control on your buckets. Additionally, when ABAC is enabled, you must use the [TagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_TagResource.html) and [UntagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UntagResource.html) actions to manage tags on your buckets. You can nolonger use the [PutBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) and [DeleteBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) actions to tag your bucket. For more information, see [Enabling ABAC in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html). parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: uploadId - in: query - required: true - schema: - $ref: '#/components/schemas/MultipartUploadId' - - name: x-amz-checksum-crc32 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32' - - name: x-amz-checksum-crc32c - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32C' - - name: x-amz-checksum-crc64nvme - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC64NVME' - - name: x-amz-checksum-sha1 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA1' - - name: x-amz-checksum-sha256 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA256' - - name: x-amz-checksum-type - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumType' - - name: x-amz-mp-object-size + - name: Content-MD5 in: header required: false schema: - $ref: '#/components/schemas/MpuObjectSize' - - name: x-amz-request-payer + $ref: '#/components/schemas/ContentMD5' + - name: x-amz-sdk-checksum-algorithm in: header required: false schema: - $ref: '#/components/schemas/RequestPayer' + $ref: '#/components/schemas/ChecksumAlgorithm' - name: x-amz-expected-bucket-owner in: header required: false schema: $ref: '#/components/schemas/AccountId' - - name: If-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatch' - - name: If-None-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfNoneMatch' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' requestBody: required: true content: application/xml: schema: - $ref: '#/components/schemas/CompletedMultipartUpload' + $ref: '#/components/schemas/AbacStatus' + responses: + '200': + description: Success + /?acl: + servers: + - url: 'https://{Bucket:.+}.s3-{region}.amazonaws.com' + variables: + Bucket: + default: stackql-trial-bucket-02 + region: + default: us-east-1 + get: + operationId: GetBucketAcl + description: |- + This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). + + 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the _Amazon S3 User Guide_. + + You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. + + The following operations are related to `GetBucketAcl`: + + * [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) + parameters: + - name: created_date + in: context + required: false + schema: + type: string + - name: x-amz-expected-bucket-owner + in: header + required: false + schema: + $ref: '#/components/schemas/AccountId' responses: '200': description: Success content: text/xml: schema: - $ref: '#/components/schemas/CompleteMultipartUploadOutput' - head: - operationId: HeadObject - description: "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.\n\nA `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.\n\nRequest headers are limited to 8 KB in\ - \ size. For more information, see [Common Request Headers](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html).\n\ - \nPermissions\n\n \n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html)\ - \ in the _Amazon S3 User Guide_. For more information about the permissions\ - \ to S3 API operations by S3 resource types, see [Required permissions for\ - \ Amazon S3 API operations](/AmazonS3/latest/userguide/using-with-s3-policy-actions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf the object you request doesn't exist,\ - \ the error that Amazon S3 returns depends on whether you also have the `s3:ListBucket`\ - \ permission.\n\n * If you have the `s3:ListBucket` permission on the bucket,\ - \ Amazon S3 returns an HTTP status code `404 Not Found` error.\n\n * If\ - \ you don’t have the `s3:ListBucket` permission, Amazon S3 returns an HTTP\ - \ status code `403 Forbidden` error.\n\n * **Directory bucket permissions**\ - \ \\- To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nIf you enable `x-amz-checksum-mode` in the request and the object is encrypted\ - \ with Amazon Web Services Key Management Service (Amazon Web Services KMS),\ - \ you must also have the `kms:GenerateDataKey` and `kms:Decrypt` permissions\ - \ in IAM identity-based policies and KMS key policies for the KMS key to retrieve\ - \ the checksum of the object.\n\nEncryption\n\n \n\nEncryption 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.\n\ - \nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\ - \n * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ - \nFor more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided\ - \ Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\n**Directory bucket** \\- For directory\ - \ buckets, there are only two supported options for server-side encryption:\ - \ SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see [Protecting\ - \ data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\nVersioning\n\n \n\n * 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.\n\n\ - \ * If the specified version is a delete marker, the response returns a `405\ - \ Method Not Allowed` error and the `Last-Modified: timestamp` response header.\n\ - \n * **Directory buckets** \\- Delete marker is not supported for directory\ - \ buckets.\n\n * **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.\n\nHTTP\ - \ Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host header\ - \ syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nFor 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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe following actions are related to `HeadObject`:\n\ - \n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \n * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)\n\ + $ref: '#/components/schemas/GetBucketAclOutput' + put: + operationId: PutBucketAcl + description: "End of support notice: As of October 1, 2025, Amazon S3 has discontinued\ + \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ + \ use an Email Grantee ACL in a request after October 1, 2025, the request\ + \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ + \ 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), and South America (São\ + \ Paulo).\n\nThis operation is not supported for directory buckets.\n\nSets\ + \ the permissions on an existing bucket using access control lists (ACL).\ + \ For more information, see [Using ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).\ + \ To set the ACL of a bucket, you must have the `WRITE_ACP` permission.\n\n\ + You can use one of the following two ways to set a bucket's permissions:\n\ + \n * Specify the ACL in the request body\n\n * Specify permissions using\ + \ request headers\n\nYou cannot specify access permission using both the body\ + \ and the request headers.\n\nDepending 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.\n\n\ + 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ + \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nYou can set access\ + \ permissions by using one of the following methods:\n\n * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).\n\ + \n * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).\n\ + \nYou specify each grantee as a type=value pair, where the type is one of\ + \ the following:\n\n * `id` – if the value specified is the canonical user\ + \ ID of an Amazon Web Services account\n\n * `uri` – if you are granting\ + \ permissions to a predefined group\n\n * `emailAddress` – if the value\ + \ specified is the email address of an Amazon Web Services account\n\nUsing\ + \ email addresses to specify a grantee is only supported in the following\ + \ Amazon Web Services Regions:\n\n * US East (N. Virginia)\n\n *\ + \ US West (N. California)\n\n * US West (Oregon)\n\n * Asia Pacific\ + \ (Singapore)\n\n * Asia Pacific (Sydney)\n\n * Asia Pacific (Tokyo)\n\ + \n * Europe (Ireland)\n\n * South America (São Paulo)\n\nFor a list\ + \ of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ + \ in the Amazon Web Services General Reference.\n\nFor 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.\n\n`x-amz-grant-write:\ + \ uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\"\ + , id=\"555566667777\" `\n\nYou can use either a canned ACL or specify access\ + \ permissions explicitly. You cannot do both.\n\nGrantee Values\n\n \n\n\ + You can specify the person (grantee) to whom you're assigning access rights\ + \ (using request elements) in the following ways. For examples of how to specify\ + \ these grantee values in JSON format, see the Amazon Web Services CLI example\ + \ in [ Enabling Amazon S3 server access logging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html)\ + \ in the _Amazon S3 User Guide_.\n\n * By the person's ID:\n\n`<>ID<><>GranteesEmail<>\ + \ `\n\nDisplayName is optional and ignored in the request\n\n * By URI:\n\ + \n`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`\n\n * By\ + \ Email address:\n\n`<>Grantees@email.com<>&`\n\nThe grantee is resolved to\ + \ the CanonicalUser and, in a response to a GET Object acl request, appears\ + \ as the CanonicalUser.\n\nUsing email addresses to specify a grantee is only\ + \ supported in the following Amazon Web Services Regions:\n\n * US East\ + \ (N. Virginia)\n\n * US West (N. California)\n\n * US West (Oregon)\n\ + \n * Asia Pacific (Singapore)\n\n * Asia Pacific (Sydney)\n\n * Asia\ + \ Pacific (Tokyo)\n\n * Europe (Ireland)\n\n * South America (São Paulo)\n\ + \nFor a list of all the Amazon S3 supported Regions and endpoints, see [Regions\ + \ and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ + \ in the Amazon Web Services General Reference.\n\nThe following operations\ + \ are related to `PutBucketAcl`:\n\n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ + \n * [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n\ + \n * [GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)\n\ \nYou must URL encode any signed header values that contain spaces. For example,\ \ if your header value is `my file.txt`, containing two spaces after `my`,\ \ you must URL encode this value to `my%20%20file.txt`." parameters: + - name: x-amz-acl + in: header + required: false + schema: + $ref: '#/components/schemas/BucketCannedACL' - name: Bucket in: path required: true schema: $ref: '#/components/schemas/BucketName' - - name: If-Match + - name: Content-MD5 in: header required: false schema: - $ref: '#/components/schemas/IfMatch' - - name: If-Modified-Since + $ref: '#/components/schemas/ContentMD5' + - name: x-amz-sdk-checksum-algorithm in: header required: false schema: - $ref: '#/components/schemas/IfModifiedSince' - - name: If-None-Match + $ref: '#/components/schemas/ChecksumAlgorithm' + - name: x-amz-grant-full-control in: header required: false schema: - $ref: '#/components/schemas/IfNoneMatch' - - name: If-Unmodified-Since + $ref: '#/components/schemas/GrantFullControl' + - name: x-amz-grant-read in: header required: false schema: - $ref: '#/components/schemas/IfUnmodifiedSince' - - name: Key - in: path - required: true + $ref: '#/components/schemas/GrantRead' + - name: x-amz-grant-read-acp + in: header + required: false schema: - $ref: '#/components/schemas/ObjectKey' - - name: Range + $ref: '#/components/schemas/GrantReadACP' + - name: x-amz-grant-write in: header required: false schema: - $ref: '#/components/schemas/Range' - - name: response-cache-control - in: query + $ref: '#/components/schemas/GrantWrite' + - name: x-amz-grant-write-acp + in: header required: false schema: - $ref: '#/components/schemas/ResponseCacheControl' - - name: response-content-disposition - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentDisposition' - - name: response-content-encoding - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentEncoding' - - name: response-content-language - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentLanguage' - - name: response-content-type - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentType' - - name: response-expires - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseExpires' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: partNumber - in: query - required: false - schema: - $ref: '#/components/schemas/PartNumber' + $ref: '#/components/schemas/GrantWriteACP' - name: x-amz-expected-bucket-owner in: header required: false schema: $ref: '#/components/schemas/AccountId' - - name: x-amz-checksum-mode - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumMode' + requestBody: + required: true + content: + application/xml: + schema: + $ref: '#/components/schemas/AccessControlPolicy' responses: '200': description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/HeadObjectOutput' - '400': - content: - text/xml: - schema: - $ref: '#/components/schemas/NotFound' - description: |- - The specified content does not exist. - /{Bucket}/{Key+}?x-id=CopyObject: - put: - operationId: CopyObject - description: "Creates a copy of an object that is already stored in Amazon S3.\n\ - \nEnd of support notice: As of October 1, 2025, Amazon S3 has discontinued\ - \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ - \ use an Email Grantee ACL in a request after October 1, 2025, the request\ - \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ - \ 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), and South America (São\ - \ Paulo).\n\nYou can store individual objects of up to 50 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html).\n\ - \nYou can copy individual objects between general purpose buckets, between\ - \ directory buckets, and between general purpose buckets and directory buckets.\n\ - \n * Amazon S3 supports copy operations using Multi-Region Access Points\ - \ only as a destination when using the Multi-Region Access Point ARN. \n\n\ - \ * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\n * VPC endpoints don't support cross-Region\ - \ requests (including copies). If you're using VPC endpoints, your source\ - \ and destination buckets should be in the same Amazon Web Services Region\ - \ as your VPC endpoint.\n\nBoth 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. For more information about how to enable a Region for\ - \ your account, see [Enable or disable a Region for standalone accounts](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone)\ - \ in the _Amazon Web Services Account Management Guide_.\n\nAmazon 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).\n\ - \nAuthentication and authorization\n\n \n\nAll `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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).\n\ - \n**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.\n\nAmazon Web Services CLI or SDKs handles authentication and\ - \ authorization on your behalf.\n\nPermissions\n\n \n\nYou must have _read_\ - \ access to the source object and _write_ access to the destination bucket.\n\ - \n * **General purpose bucket permissions** \\- You must have permissions\ - \ in an IAM policy based on the source and destination bucket types in a `CopyObject`\ - \ operation.\n\n * 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. \n\n * If the destination bucket is a general purpose\ - \ bucket, you must have **`s3:PutObject` ** permission to write the object\ - \ copy to the destination bucket. \n\n * **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.\n\n * 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.\n\n * 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. \n\nIf the object is encrypted with SSE-KMS, you\ - \ must also have the `kms:GenerateDataKey` and `kms:Decrypt` permissions in\ - \ IAM identity-based policies and KMS key policies for the KMS key.\n\nFor\ - \ example policies, see [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)\ - \ and [Amazon Web Services Identity and Access Management (IAM) identity-based\ - \ policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\nResponse and special errors\n\n \n\n\ - 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.\n\n * If the copy is successful, you receive a response\ - \ with information about the copied object.\n\n * 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.\n\n * If the error occurs before the copy action starts, you receive\ - \ a standard Amazon S3 error.\n\n * 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](https://repost.aws/knowledge-center/s3-resolve-200-internalerror).\ - \ 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.\n\nIf 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).\n\nCharge\n\n \n\nThe 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. If the copy source is\ - \ in a different region, the data transfer is billed to the copy source account.\ - \ For pricing information, see [Amazon S3 pricing](http://aws.amazon.com/s3/pricing/).\n\ - \nHTTP Host header syntax\n\n \n\n * **Directory buckets** \\- The HTTP\ - \ Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \n * **Amazon S3 on Outposts** \\- When you use this action with S3 on Outposts\ - \ through the REST API, 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`.\ - \ The hostname isn't required when you use the Amazon Web Services CLI or\ - \ SDKs.\n\nThe following operations are related to `CopyObject`:\n\n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-acl - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectCannedACL' - - name: Bucket - in: path - required: true - schema: +components: + schemas: + AbacInputOverride: + type: object + description: A convenience for presentation + properties: + line_items: + type: array + items: + $ref: '#/components/schemas/AbacInputOverrideJunk' + status: + type: string + AbacInputOverrideJunk: + type: object + properties: + comment: + type: string + source: + type: string + id: + type: number + AbacStatus: + type: object + properties: + Status: + $ref: '#/components/schemas/BucketAbacStatus' + description: The ABAC status of the general purpose bucket. + description: The ABAC status of the general purpose bucket. When ABAC is enabled + for the general purpose bucket, you can use tags to manage access to the general + purpose buckets as well as for cost tracking purposes. When ABAC is disabled + for the general purpose buckets, you can only use tags for cost tracking purposes. + For more information, see [Using tags with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html). + AbortDate: + type: string + format: date-time + AbortIncompleteMultipartUpload: + type: object + properties: + DaysAfterInitiation: + $ref: '#/components/schemas/DaysAfterInitiation' + description: Specifies the number of days after which Amazon S3 aborts an + incomplete multipart upload. + description: Specifies the days since the initiation of an incomplete multipart + upload that Amazon S3 will wait before permanently removing all parts of the + upload. For more information, see [ Aborting Incomplete Multipart Uploads + Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + in the _Amazon S3 User Guide_. + AbortMultipartUploadOutput: + type: object + properties: + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + AbortMultipartUploadRequest: + type: object + properties: + Bucket: $ref: '#/components/schemas/BucketName' - - name: Cache-Control - in: header - required: false - schema: - $ref: '#/components/schemas/CacheControl' - - name: x-amz-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: Content-Disposition - in: header - required: false - schema: - $ref: '#/components/schemas/ContentDisposition' - - name: Content-Encoding - in: header - required: false - schema: - $ref: '#/components/schemas/ContentEncoding' - - name: Content-Language - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLanguage' - - name: Content-Type - in: header - required: false - schema: - $ref: '#/components/schemas/ContentType' - - name: x-amz-copy-source - in: header - required: true - schema: - $ref: '#/components/schemas/CopySource' - - name: x-amz-copy-source-if-match - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfMatch' - - name: x-amz-copy-source-if-modified-since - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfModifiedSince' - - name: x-amz-copy-source-if-none-match - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfNoneMatch' - - name: x-amz-copy-source-if-unmodified-since - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfUnmodifiedSince' - - name: Expires - in: header - required: false - schema: - $ref: '#/components/schemas/Expires' - - name: x-amz-grant-full-control - in: header - required: false - schema: - $ref: '#/components/schemas/GrantFullControl' - - name: x-amz-grant-read - in: header - required: false - schema: - $ref: '#/components/schemas/GrantRead' - - name: x-amz-grant-read-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantReadACP' - - name: x-amz-grant-write-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWriteACP' - - name: If-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatch' - - name: If-None-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfNoneMatch' - - name: Key - in: path - required: true - schema: + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: $ref: '#/components/schemas/ObjectKey' - - name: x-amz-metadata-directive - in: header - required: false - schema: - $ref: '#/components/schemas/MetadataDirective' - - name: x-amz-tagging-directive - in: header - required: false - schema: - $ref: '#/components/schemas/TaggingDirective' - - name: x-amz-server-side-encryption - in: header - required: false - schema: - $ref: '#/components/schemas/ServerSideEncryption' - - name: x-amz-storage-class - in: header - required: false - schema: - $ref: '#/components/schemas/StorageClass' - - name: x-amz-website-redirect-location - in: header - required: false - schema: - $ref: '#/components/schemas/WebsiteRedirectLocation' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-server-side-encryption-aws-kms-key-id - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSKeyId' - - name: x-amz-server-side-encryption-context - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - - name: x-amz-server-side-encryption-bucket-key-enabled - in: header - required: false - schema: - $ref: '#/components/schemas/BucketKeyEnabled' - - name: x-amz-copy-source-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceSSECustomerAlgorithm' - - name: x-amz-copy-source-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceSSECustomerKey' - - name: x-amz-copy-source-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceSSECustomerKeyMD5' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-tagging - in: header - required: false - schema: - $ref: '#/components/schemas/TaggingHeader' - - name: x-amz-object-lock-mode - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockMode' - - name: x-amz-object-lock-retain-until-date - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - - name: x-amz-object-lock-legal-hold - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-source-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyObjectOutput' - '403': - content: - text/xml: - schema: - $ref: '#/components/schemas/ObjectNotInActiveTierError' - description: |- - The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier. - /?max-keys=1000: - servers: - - url: 'https://{Bucket}.s3-{region}.amazonaws.com' - variables: - Bucket: - default: stackql-trial-bucket-02 - region: - default: us-east-1 - get: - description: "This operation is not supported for directory buckets.\n\nReturns\ - \ 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.\n\ - \nThis action has been revised. We recommend that you use the newer version,\ - \ [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html),\ - \ when developing applications. For backward compatibility, Amazon S3 continues\ - \ to support `ListObjects`.\n\nThe following operations are related to `ListObjects`:\n\ - \n * [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)\n\ - \n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \n * [ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - operationId: ListObjects - parameters: - - in: header - name: x-amz-content-sha256 - required: false - schema: - default: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - type: string - - in: query - name: delimiter - required: false - schema: - $ref: '#/components/schemas/Delimiter' - - in: query - name: encoding-type - required: false - schema: - $ref: '#/components/schemas/EncodingType' - - in: query - name: marker - required: false - schema: - $ref: '#/components/schemas/Marker' - - in: query - name: max_keys - required: false - schema: - type: integer - default: 1000 - - in: query - name: prefix - required: false - schema: - $ref: '#/components/schemas/Prefix' - - in: header - name: x-amz-request-payer - required: false - schema: + description: Key of the object for which the multipart upload was initiated. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: Upload ID that identifies the multipart upload. + RequestPayer: $ref: '#/components/schemas/RequestPayer' - - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - $ref: '#/components/schemas/AccountId' - - in: header - name: x-amz-optional-object-attributes - required: false - schema: - $ref: '#/components/schemas/OptionalObjectAttributesList' - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectsOutput' - description: Success - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: The specified bucket does not exist. - /{Bucket}: - put: - operationId: CreateBucket - description: "This action creates an Amazon S3 bucket. To create an Amazon S3\ - \ on Outposts bucket, see [ `CreateBucket` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html).\n\ - \nCreates 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.\n\nThere 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **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: \n\n * **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. \n\n * **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.\n\n * **S3 Object Ownership** \\- If your `CreateBucket`\ - \ request includes the `x-amz-object-ownership` header, then the `s3:PutBucketOwnershipControls`\ - \ permission is required.\n\nTo set an ACL on a bucket as part of a `CreateBucket`\ - \ request, you must explicitly set S3 Object Ownership for the bucket to a\ - \ different value than the default, `BucketOwnerEnforced`. Additionally, if\ - \ your desired bucket ACL grants public access, you must first create the\ - \ bucket (without the bucket ACL) and then explicitly disable Block Public\ - \ Access on the bucket before using `PutBucketAcl` to set the ACL. If you\ - \ try to create a bucket with a public ACL, the request will fail.\n\nFor\ - \ the majority of modern use cases in S3, we recommend that you keep all Block\ - \ Public Access settings enabled and keep ACLs disabled. If you would like\ - \ to share data with users outside of your account, you can use bucket policies\ - \ as needed. For more information, see [Controlling ownership of objects and\ - \ disabling ACLs for your bucket ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ - \ and [Blocking public access to your Amazon S3 storage ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **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`\ - \ ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)\ - \ 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 ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html)\ - \ in the _Amazon S3 User Guide_. \n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe 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.\n\nFor more information\ - \ about permissions for creating and working with directory buckets, see [Directory\ - \ buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)\ - \ in the _Amazon S3 User Guide_. For more information about supported S3 features\ - \ for directory buckets, see [Features of S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `CreateBucket`:\n\n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \n * [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-acl - in: header - required: false - schema: - $ref: '#/components/schemas/BucketCannedACL' - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-grant-full-control - in: header - required: false - schema: - $ref: '#/components/schemas/GrantFullControl' - - name: x-amz-grant-read - in: header - required: false - schema: - $ref: '#/components/schemas/GrantRead' - - name: x-amz-grant-read-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantReadACP' - - name: x-amz-grant-write - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWrite' - - name: x-amz-grant-write-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWriteACP' - - name: x-amz-bucket-object-lock-enabled - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockEnabledForBucket' - - name: x-amz-object-ownership - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectOwnership' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/CreateBucketConfiguration' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateBucketOutput' - '409': - content: - text/xml: - schema: - $ref: '#/components/schemas/BucketAlreadyOwnedByYou' - description: |- - 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). - delete: - operationId: DeleteBucket - description: "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.\n\n * **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.\n\n * **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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- You must have the `s3:DeleteBucket` permission\ - \ on the specified bucket in a policy.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `DeleteBucket`:\n\n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \n * [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - head: - operationId: HeadBucket - description: "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` HTTP\ - \ status code if the bucket exists and you have permission to access it. You\ - \ can make a `HeadBucket` call on any bucket name to any Region in the partition,\ - \ and regardless of the permissions on the bucket, you will receive a response\ - \ header with the correct bucket location so that you can then make a proper,\ - \ signed request to the appropriate Regional endpoint.\n\nIf the bucket doesn't\ - \ exist or you don't have permission to access it, the `HEAD` request returns\ - \ a generic `400 Bad Request`, `403 Forbidden`, or `404 Not Found` HTTP status\ - \ code. A message body isn't included, so you can't determine the exception\ - \ beyond these HTTP response codes.\n\nAuthentication and authorization\n\n\ - \ \n\n**General purpose buckets** \\- Request to public buckets that grant\ - \ the s3:ListBucket permission publicly do not need to be signed. All other\ - \ `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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).\n\ - \n**Directory buckets** \\- 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.\n\ - \nAmazon Web Services CLI or SDKs handles authentication and authorization\ - \ on your behalf.\n\nPermissions\n\n \n\n * **General purpose bucket permissions**\ - \ \\- 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 [Managing\ - \ access permissions to your Amazon S3 resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - You must have the **`s3express:CreateSession` ** permission in the `Action`\ - \ element of a policy. 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 bucket.\n\nFor more information about\ - \ example bucket policies, see [Example bucket policies for S3 Express One\ - \ Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)\ - \ and [Amazon Web Services Identity and Access Management (IAM) identity-based\ - \ policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nYou 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-_zone-id_._region-code_.amazonaws.com`.\ - \ Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou must URL encode any signed header\ - \ values that contain spaces. For example, if your header value is `my file.txt`,\ - \ containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: + ExpectedBucketOwner: $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/HeadBucketOutput' - '400': - content: - text/xml: - schema: - $ref: '#/components/schemas/NotFound' - description: |- - The specified content does not exist. - get: - operationId: ListObjects - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), when developing applications. For backward compatibility, Amazon S3 continues to support `ListObjects`. - - The following operations are related to `ListObjects`: - - * [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) - - * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) - - * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) + description: 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). + IfMatchInitiatedTime: + $ref: '#/components/schemas/IfMatchInitiatedTime' + description: 'If present, this header aborts an in progress multipart upload + only if it was initiated on the provided timestamp. If the initiated timestamp + of the multipart upload does not match the provided value, the operation + returns a `412 Precondition Failed` error. If the initiated timestamp + matches or if the multipart upload doesn’t exist, the operation returns + a `204 Success (No Content)` response. - * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) - * [ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) + This functionality is only supported for directory buckets.' + required: + - Bucket + - Key + - UploadId + AbortRuleId: + type: string + AccelerateConfiguration: + type: object + properties: + Status: + $ref: '#/components/schemas/BucketAccelerateStatus' + description: Specifies the transfer acceleration status of the bucket. + description: Configures the transfer acceleration state for an Amazon S3 bucket. + For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) + in the _Amazon S3 User Guide_. + AcceptRanges: + type: string + AccessControlPolicy: + type: object + properties: + Grants: + $ref: '#/components/schemas/Grants' + description: A list of grants. + Owner: + $ref: '#/components/schemas/Owner' + description: Container for the bucket owner's display name and ID. + description: Contains the elements that set the ACL permissions for an object + per grantee. + AccessControlTranslation: + type: object + properties: + Owner: + $ref: '#/components/schemas/OwnerOverride' + description: Specifies the replica ownership. For default and valid values, + see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) + in the _Amazon S3 API Reference_. + required: + - Owner + description: A container for information about access control for replicas. + AccessKeyIdValue: + type: string + AccessPointAlias: + type: boolean + AccessPointArn: + type: string + AccountId: + type: string + AllowQuotedRecordDelimiter: + type: boolean + AllowedHeader: + type: string + AllowedHeaders: + type: array + items: + $ref: '#/components/schemas/AllowedHeader' + AllowedMethod: + type: string + AllowedMethods: + type: array + items: + $ref: '#/components/schemas/AllowedMethod' + AllowedOrigin: + type: string + AllowedOrigins: + type: array + items: + $ref: '#/components/schemas/AllowedOrigin' + AnalyticsAndOperator: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'The prefix to use when evaluating an AND predicate: The prefix + that an object must have to be included in the metrics results.' + Tags: + $ref: '#/components/schemas/TagSet' + description: The list of tags to use when evaluating an AND predicate. + description: A conjunction (logical AND) of predicates, which is used in evaluating + a metrics filter. The operator must have at least two predicates in any combination, + and an object must match all of the predicates for the filter to apply. + AnalyticsConfiguration: + type: object + properties: + Id: + $ref: '#/components/schemas/AnalyticsId' + description: The ID that identifies the analytics configuration. + Filter: + $ref: '#/components/schemas/AnalyticsFilter' + description: The filter used to describe a set of objects for analyses. + A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). + If no filter is provided, all objects will be considered in any analysis. + StorageClassAnalysis: + $ref: '#/components/schemas/StorageClassAnalysis' + description: Contains data related to access patterns to be collected and + made available to analyze the tradeoffs between different storage classes. + required: + - Id + - StorageClassAnalysis + description: Specifies the configuration and any analyses for the analytics + filter of an Amazon S3 bucket. + AnalyticsConfigurationList: + type: array + items: + $ref: '#/components/schemas/AnalyticsConfiguration' + AnalyticsExportDestination: + type: object + properties: + S3BucketDestination: + $ref: '#/components/schemas/AnalyticsS3BucketDestination' + description: A destination signifying output to an S3 bucket. + required: + - S3BucketDestination + description: Where to publish the analytics results. + AnalyticsFilter: + allOf: + - $ref: '#/components/schemas/Prefix' + description: |- + The prefix to use when evaluating an analytics filter. + - $ref: '#/components/schemas/Tag' + description: |- + The tag to use when evaluating an analytics filter. + - $ref: '#/components/schemas/AnalyticsAndOperator' + description: |- + A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates. + description: |- + The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis. + AnalyticsId: + type: string + AnalyticsS3BucketDestination: + type: object + properties: + Format: + $ref: '#/components/schemas/AnalyticsS3ExportFileFormat' + description: Specifies the file format used when exporting data to Amazon + S3. + BucketAccountId: + $ref: '#/components/schemas/AccountId' + description: 'The account ID that owns the destination S3 bucket. If no + account ID is provided, the owner is not validated before exporting data. - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: + + Although this value is optional, we strongly recommend that you set it + to help prevent problems if the destination bucket ownership changes.' + Bucket: $ref: '#/components/schemas/BucketName' - - name: x-amz-content-sha256 - in: header - required: false - schema: - type: string - default: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - - name: delimiter - in: query - required: false - schema: - $ref: '#/components/schemas/Delimiter' - - name: encoding-type - in: query - required: false - schema: - $ref: '#/components/schemas/EncodingType' - - name: marker - in: query - required: false - schema: - $ref: '#/components/schemas/Marker' - - name: max-keys - in: query - required: false - schema: - $ref: '#/components/schemas/MaxKeys' - - name: prefix - in: query - required: false - schema: + description: The Amazon Resource Name (ARN) of the bucket to which data + is exported. + Prefix: $ref: '#/components/schemas/Prefix' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-optional-object-attributes - in: header - required: false - schema: - $ref: '#/components/schemas/OptionalObjectAttributesList' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectsOutput' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: |- - The specified bucket does not exist. - /{Bucket}?metadataConfiguration: - post: - operationId: CreateBucketMetadataConfiguration - description: "Creates an S3 Metadata V2 metadata configuration for a general\ - \ purpose bucket. For more information, see [Accelerating data discovery with\ - \ S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nTo use this operation,\ - \ you must have the following permissions. For more information, see [Setting\ - \ up permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf you want to encrypt your metadata tables\ - \ with server-side encryption with Key Management Service (KMS) keys (SSE-KMS),\ - \ you need additional permissions in your KMS key policy. For more information,\ - \ see [ Setting up permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf you also want to integrate your table\ - \ bucket with Amazon Web Services analytics services so that you can query\ - \ your metadata table, you need additional permissions. For more information,\ - \ see [ Integrating Amazon S3 Tables with Amazon Web Services analytics services](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html)\ - \ in the _Amazon S3 User Guide_.\n\nTo query your metadata tables, you need\ - \ additional permissions. For more information, see [ Permissions for querying\ - \ metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-bucket-query-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\n * `s3:CreateBucketMetadataTableConfiguration`\n\ - \nThe IAM policy action name is the same for the V1 and V2 API operations.\n\ - \n * `s3tables:CreateTableBucket`\n\n * `s3tables:CreateNamespace`\n\n \ - \ * `s3tables:GetTable`\n\n * `s3tables:CreateTable`\n\n * `s3tables:PutTablePolicy`\n\ - \n * `s3tables:PutTableEncryption`\n\n * `kms:DescribeKey`\n\nThe following\ - \ operations are related to `CreateBucketMetadataConfiguration`:\n\n * [DeleteBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html)\n\ - \n * [GetBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataConfiguration.html)\n\ - \n * [UpdateBucketMetadataInventoryTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataInventoryTableConfiguration.html)\n\ - \n * [UpdateBucketMetadataJournalTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: + description: The prefix to use when exporting data. The prefix is prepended + to all results. + required: + - Format + - Bucket + description: Contains information about where to publish the analytics results. + AnalyticsS3ExportFileFormat: + type: string + enum: + - CSV + ArchiveStatus: + type: string + enum: + - ARCHIVE_ACCESS + - DEEP_ARCHIVE_ACCESS + BlockedEncryptionTypes: + type: object + properties: + EncryptionType: + $ref: '#/components/schemas/EncryptionTypeList' + description: 'The object encryption type that you want to block or unblock + for an Amazon S3 general purpose bucket. + + + Currently, this parameter only supports blocking or unblocking server + side encryption with customer-provided keys (SSE-C). For more information + about SSE-C, see [Using server-side encryption with customer-provided + keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).' + description: "A bucket-level setting for Amazon S3 general purpose buckets used\ + \ to prevent the upload of new objects encrypted with the specified server-side\ + \ encryption type. For example, blocking an encryption type will block `PutObject`,\ + \ `CopyObject`, `PostObject`, multipart upload, and replication requests to\ + \ the bucket for objects with the specified encryption type. However, you\ + \ can continue to read and list any pre-existing objects already encrypted\ + \ with the specified encryption type. For more information, see [Blocking\ + \ or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).\n\ + \nThis data type is used with the following actions:\n\n * [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)\n\ + \n * [GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)\n\ + \n * [DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)\n\ + \nPermissions\n\n \n\nYou must have the `s3:PutEncryptionConfiguration`\ + \ permission to block or unblock an encryption type for a bucket.\n\nYou must\ + \ have the `s3:GetEncryptionConfiguration` permission to view a bucket's encryption\ + \ type." + Body: + type: string + format: byte + Bucket: + type: object + properties: + Name: $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/MetadataConfiguration' - responses: - '200': - description: Success - delete: - operationId: DeleteBucketMetadataConfiguration - description: "Deletes an S3 Metadata configuration from a general purpose bucket.\ - \ For more information, see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou can use the V2 `DeleteBucketMetadataConfiguration`\ - \ API operation with V1 or V2 metadata configurations. However, if you try\ - \ to use the V1 `DeleteBucketMetadataTableConfiguration` API operation with\ - \ V2 configurations, you will receive an HTTP `405 Method Not Allowed` error.\n\ - \nPermissions\n\n \n\nTo use this operation, you must have the `s3:DeleteBucketMetadataTableConfiguration`\ - \ permission. For more information, see [Setting up permissions for configuring\ - \ metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe IAM policy action name is the same\ - \ for the V1 and V2 API operations.\n\nThe following operations are related\ - \ to `DeleteBucketMetadataConfiguration`:\n\n * [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\n\ - \n * [GetBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataConfiguration.html)\n\ - \n * [UpdateBucketMetadataInventoryTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataInventoryTableConfiguration.html)\n\ - \n * [UpdateBucketMetadataJournalTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketMetadataConfiguration - description: "Retrieves the S3 Metadata configuration for a general purpose\ - \ bucket. For more information, see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou can use the V2 `GetBucketMetadataConfiguration`\ - \ API operation with V1 or V2 metadata configurations. However, if you try\ - \ to use the V1 `GetBucketMetadataTableConfiguration` API operation with V2\ - \ configurations, you will receive an HTTP `405 Method Not Allowed` error.\n\ - \nPermissions\n\n \n\nTo use this operation, you must have the `s3:GetBucketMetadataTableConfiguration`\ - \ permission. For more information, see [Setting up permissions for configuring\ - \ metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe IAM policy action name is the same\ - \ for the V1 and V2 API operations.\n\nThe following operations are related\ - \ to `GetBucketMetadataConfiguration`:\n\n * [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\n\ - \n * [DeleteBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html)\n\ - \n * [UpdateBucketMetadataInventoryTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataInventoryTableConfiguration.html)\n\ - \n * [UpdateBucketMetadataJournalTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketMetadataConfigurationOutput' - /{Bucket}?metadataTable: - post: - operationId: CreateBucketMetadataTableConfiguration - description: "We recommend that you create your S3 Metadata configurations by\ - \ using the V2 [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\ - \ API operation. We no longer recommend using the V1 `CreateBucketMetadataTableConfiguration`\ - \ API operation.\n\nIf you created your S3 Metadata configuration before July\ - \ 15, 2025, we recommend that you delete and re-create your configuration\ - \ by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\ - \ so that you can expire journal table records and create a live inventory\ - \ table.\n\nCreates a V1 S3 Metadata configuration for a general purpose bucket.\ - \ For more information, see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nTo use this operation,\ - \ you must have the following permissions. For more information, see [Setting\ - \ up permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf you want to encrypt your metadata tables\ - \ with server-side encryption with Key Management Service (KMS) keys (SSE-KMS),\ - \ you need additional permissions. For more information, see [ Setting up\ - \ permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf you also want to integrate your table\ - \ bucket with Amazon Web Services analytics services so that you can query\ - \ your metadata table, you need additional permissions. For more information,\ - \ see [ Integrating Amazon S3 Tables with Amazon Web Services analytics services](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html)\ - \ in the _Amazon S3 User Guide_.\n\n * `s3:CreateBucketMetadataTableConfiguration`\n\ - \n * `s3tables:CreateNamespace`\n\n * `s3tables:GetTable`\n\n * `s3tables:CreateTable`\n\ - \n * `s3tables:PutTablePolicy`\n\nThe following operations are related to\ - \ `CreateBucketMetadataTableConfiguration`:\n\n * [DeleteBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html)\n\ - \n * [GetBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/MetadataTableConfiguration' - responses: - '200': - description: Success - delete: - operationId: DeleteBucketMetadataTableConfiguration - description: "We recommend that you delete your S3 Metadata configurations by\ - \ using the V2 [DeleteBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html)\ - \ API operation. We no longer recommend using the V1 `DeleteBucketMetadataTableConfiguration`\ - \ API operation.\n\nIf you created your S3 Metadata configuration before July\ - \ 15, 2025, we recommend that you delete and re-create your configuration\ - \ by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\ - \ so that you can expire journal table records and create a live inventory\ - \ table.\n\nDeletes a V1 S3 Metadata configuration from a general purpose\ - \ bucket. For more information, see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou can use the V2 `DeleteBucketMetadataConfiguration`\ - \ API operation with V1 or V2 metadata table configurations. However, if you\ - \ try to use the V1 `DeleteBucketMetadataTableConfiguration` API operation\ - \ with V2 configurations, you will receive an HTTP `405 Method Not Allowed`\ - \ error.\n\nMake sure that you update your processes to use the new V2 API\ - \ operations (`CreateBucketMetadataConfiguration`, `GetBucketMetadataConfiguration`,\ - \ and `DeleteBucketMetadataConfiguration`) instead of the V1 API operations.\n\ - \nPermissions\n\n \n\nTo use this operation, you must have the `s3:DeleteBucketMetadataTableConfiguration`\ - \ permission. For more information, see [Setting up permissions for configuring\ - \ metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe following operations are related to\ - \ `DeleteBucketMetadataTableConfiguration`:\n\n * [CreateBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html)\n\ - \n * [GetBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketMetadataTableConfiguration - description: "We recommend that you retrieve your S3 Metadata configurations\ - \ by using the V2 [GetBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html)\ - \ API operation. We no longer recommend using the V1 `GetBucketMetadataTableConfiguration`\ - \ API operation.\n\nIf you created your S3 Metadata configuration before July\ - \ 15, 2025, we recommend that you delete and re-create your configuration\ - \ by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\ - \ so that you can expire journal table records and create a live inventory\ - \ table.\n\nRetrieves the V1 S3 Metadata configuration for a general purpose\ - \ bucket. For more information, see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou can use the V2 `GetBucketMetadataConfiguration`\ - \ API operation with V1 or V2 metadata table configurations. However, if you\ - \ try to use the V1 `GetBucketMetadataTableConfiguration` API operation with\ - \ V2 configurations, you will receive an HTTP `405 Method Not Allowed` error.\n\ - \nMake sure that you update your processes to use the new V2 API operations\ - \ (`CreateBucketMetadataConfiguration`, `GetBucketMetadataConfiguration`,\ - \ and `DeleteBucketMetadataConfiguration`) instead of the V1 API operations.\n\ - \nPermissions\n\n \n\nTo use this operation, you must have the `s3:GetBucketMetadataTableConfiguration`\ - \ permission. For more information, see [Setting up permissions for configuring\ - \ metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe following operations are related to\ - \ `GetBucketMetadataTableConfiguration`:\n\n * [CreateBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html)\n\ - \n * [DeleteBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketMetadataTableConfigurationOutput' - /{Bucket}/{Key+}?uploads: - post: - operationId: CreateMultipartUpload - description: "End of support notice: As of October 1, 2025, Amazon S3 has discontinued\ - \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ - \ use an Email Grantee ACL in a request after October 1, 2025, the request\ - \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ - \ 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), and South America (São\ - \ Paulo).\n\nThis 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)).\ - \ 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\ - \ in the _Amazon S3 User Guide_.\n\nAfter 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.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).\n\ - \n * **Directory buckets** \\- S3 Lifecycle is not supported by directory\ - \ buckets.\n\n * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nRequest signing\n\n \n\nFor 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)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- To perform a multipart upload with encryption using\ - \ an Key Management Service (KMS) KMS key, the requester must have permission\ - \ to the `kms:Decrypt` and `kms:GenerateDataKey` actions on the key. The requester\ - \ must also have permissions for the `kms:GenerateDataKey` action for the\ - \ `CreateMultipartUpload` API. Then, the requester needs permissions for the\ - \ `kms:Decrypt` action on the `UploadPart` and `UploadPartCopy` APIs. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)\ - \ and [Protecting data using server-side encryption with Amazon Web Services\ - \ KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nEncryption\n\n \n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)\ - \ requests must match the headers you used in the `CreateMultipartUpload`\ - \ request.\n\n * 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.\n\n \ - \ * `x-amz-server-side-encryption`\n\n * `x-amz-server-side-encryption-aws-kms-key-id`\n\ - \n * `x-amz-server-side-encryption-context`\n\n * 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.\n\n * 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)\ - \ and [Protecting data using server-side encryption with Amazon Web Services\ - \ KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * 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.\n\n \ - \ * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)\ - \ in the _Amazon S3 User Guide_.\n\nFor more information about server-side\ - \ encryption with KMS keys (SSE-KMS), see [Protecting Data Using Server-Side\ - \ Encryption with KMS keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * Use customer-provided encryption\ - \ keys (SSE-C) – If you want to manage your own encryption keys, provide all\ - \ the following headers in the request.\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\ - \n * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ - \nFor 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)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- For directory\ - \ buckets, there are only two supported options for server-side encryption:\ - \ server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and\ - \ server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We recommend\ - \ that the bucket's default encryption uses the desired encryption configuration\ - \ and you don't override the bucket default encryption in your `CreateSession`\ - \ requests or `PUT` object requests. Then, new objects are automatically encrypted\ - \ with the desired encryption settings. For more information, see [Protecting\ - \ data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_. For more information about the encryption\ - \ overriding behaviors in directory buckets, see [Specifying server-side encryption\ - \ with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\n\ - \nIn the Zonal endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))\ - \ using the REST API, the encryption request headers must match the encryption\ - \ settings that are specified in the `CreateSession` request. You can't override\ - \ the values of the encryption settings (`x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`,\ - \ `x-amz-server-side-encryption-context`, and `x-amz-server-side-encryption-bucket-key-enabled`)\ - \ that are specified in the `CreateSession` request. You don't need to explicitly\ - \ specify these encryption settings values in Zonal endpoint API calls, and\ - \ Amazon S3 will use the encryption settings values from the `CreateSession`\ - \ request to protect new objects in the directory bucket.\n\nWhen you use\ - \ the CLI or the Amazon Web Services SDKs, for `CreateSession`, the session\ - \ token refreshes automatically to avoid service interruptions when a session\ - \ expires. The CLI or the Amazon Web Services SDKs use the bucket's default\ - \ encryption configuration for the `CreateSession` request. It's not supported\ - \ to override the encryption settings values in the `CreateSession` request.\ - \ So in the Zonal endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),\ - \ the encryption request headers must match the default encryption configuration\ - \ of the directory bucket.\n\nFor directory buckets, when you perform a `CreateMultipartUpload`\ - \ operation and an `UploadPartCopy` operation, the request headers you provide\ - \ in the `CreateMultipartUpload` request must match the default encryption\ - \ configuration of the destination bucket.\n\nHTTP Host header syntax\n\n\ - \ \n\n**Directory buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `CreateMultipartUpload`:\n\n *\ - \ [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-acl - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectCannedACL' - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Cache-Control - in: header - required: false - schema: - $ref: '#/components/schemas/CacheControl' - - name: Content-Disposition - in: header - required: false - schema: - $ref: '#/components/schemas/ContentDisposition' - - name: Content-Encoding - in: header - required: false - schema: - $ref: '#/components/schemas/ContentEncoding' - - name: Content-Language - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLanguage' - - name: Content-Type - in: header - required: false - schema: - $ref: '#/components/schemas/ContentType' - - name: Expires - in: header - required: false - schema: - $ref: '#/components/schemas/Expires' - - name: x-amz-grant-full-control - in: header - required: false - schema: - $ref: '#/components/schemas/GrantFullControl' - - name: x-amz-grant-read - in: header - required: false - schema: - $ref: '#/components/schemas/GrantRead' - - name: x-amz-grant-read-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantReadACP' - - name: x-amz-grant-write-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWriteACP' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-server-side-encryption - in: header - required: false - schema: - $ref: '#/components/schemas/ServerSideEncryption' - - name: x-amz-storage-class - in: header - required: false - schema: - $ref: '#/components/schemas/StorageClass' - - name: x-amz-website-redirect-location - in: header - required: false - schema: - $ref: '#/components/schemas/WebsiteRedirectLocation' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-server-side-encryption-aws-kms-key-id - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSKeyId' - - name: x-amz-server-side-encryption-context - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - - name: x-amz-server-side-encryption-bucket-key-enabled - in: header - required: false - schema: - $ref: '#/components/schemas/BucketKeyEnabled' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-tagging - in: header - required: false - schema: - $ref: '#/components/schemas/TaggingHeader' - - name: x-amz-object-lock-mode - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockMode' - - name: x-amz-object-lock-retain-until-date - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - - name: x-amz-object-lock-legal-hold - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-checksum-type - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumType' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateMultipartUploadOutput' - /{Bucket}?session: - get: - operationId: CreateSession - description: "Creates a session that establishes temporary security credentials\ - \ to support fast authentication and authorization for the Zonal endpoint\ - \ API operations on directory buckets. For more information about Zonal endpoint\ - \ API operations that include the Availability Zone in the request endpoint,\ - \ see [S3 Express One Zone APIs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html)\ - \ in the _Amazon S3 User Guide_.\n\nTo 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 API operations. 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.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication)\ - \ in the _Amazon S3 User Guide_.\n\n * 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-_zone-id_._region-code_.amazonaws.com`.\ - \ Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **`CopyObject` API operation** \\\ - - Unlike other Zonal endpoint API operations, 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html).\n\ - \n * **`HeadBucket` API operation** \\- Unlike other Zonal endpoint API operations,\ - \ 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html).\n\ - \nPermissions\n\n \n\nTo 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`\ - \ ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters).\ - \ For example policies, see [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)\ - \ and [Amazon Web Services Identity and Access Management (IAM) identity-based\ - \ policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\nTo grant cross-account access to Zonal\ - \ endpoint API operations, the bucket policy should also grant both accounts\ - \ the `s3express:CreateSession` permission.\n\nIf you want to encrypt objects\ - \ with SSE-KMS, you must also have the `kms:GenerateDataKey` and the `kms:Decrypt`\ - \ permissions in IAM identity-based policies and KMS key policies for the\ - \ target KMS key.\n\nEncryption\n\n \n\nFor directory buckets, there are\ - \ only two supported options for server-side encryption: server-side encryption\ - \ with Amazon S3 managed keys (SSE-S3) (`AES256`) and server-side encryption\ - \ with KMS keys (SSE-KMS) (`aws:kms`). We recommend that the bucket's default\ - \ encryption uses the desired encryption configuration and you don't override\ - \ the bucket default encryption in your `CreateSession` requests or `PUT`\ - \ object requests. Then, new objects are automatically encrypted with the\ - \ desired encryption settings. For more information, see [Protecting data\ - \ with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_. For more information about the encryption\ - \ overriding behaviors in directory buckets, see [Specifying server-side encryption\ - \ with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\n\ - \nFor [Zonal endpoint (object-level) API operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-differences.html#s3-express-differences-api-operations)\ - \ except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html),\ - \ you authenticate and authorize requests through [CreateSession](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ for low latency. To encrypt new objects in a directory bucket with SSE-KMS,\ - \ you must specify SSE-KMS as the directory bucket's default encryption configuration\ - \ with a KMS key (specifically, a [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)).\ - \ Then, when a session is created for Zonal endpoint API operations, new objects\ - \ are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys\ - \ during the session.\n\nOnly 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ is supported per directory bucket for the lifetime of the bucket. The [Amazon\ - \ Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\ - \ (`aws/s3`) isn't supported. After you specify SSE-KMS as your bucket's default\ - \ encryption configuration with a customer managed key, you can't change the\ - \ customer managed key for the bucket's SSE-KMS configuration.\n\nIn the Zonal\ - \ endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))\ - \ using the REST API, you can't override the values of the encryption settings\ - \ (`x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`,\ - \ `x-amz-server-side-encryption-context`, and `x-amz-server-side-encryption-bucket-key-enabled`)\ - \ from the `CreateSession` request. You don't need to explicitly specify these\ - \ encryption settings values in Zonal endpoint API calls, and Amazon S3 will\ - \ use the encryption settings values from the `CreateSession` request to protect\ - \ new objects in the directory bucket.\n\nWhen you use the CLI or the Amazon\ - \ Web Services SDKs, for `CreateSession`, the session token refreshes automatically\ - \ to avoid service interruptions when a session expires. The CLI or the Amazon\ - \ Web Services SDKs use the bucket's default encryption configuration for\ - \ the `CreateSession` request. It's not supported to override the encryption\ - \ settings values in the `CreateSession` request. Also, in the Zonal endpoint\ - \ API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),\ - \ it's not supported to override the values of the encryption settings from\ - \ the `CreateSession` request.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-create-session-mode - in: header - required: false - schema: - $ref: '#/components/schemas/SessionMode' - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-server-side-encryption - in: header - required: false - schema: - $ref: '#/components/schemas/ServerSideEncryption' - - name: x-amz-server-side-encryption-aws-kms-key-id - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSKeyId' - - name: x-amz-server-side-encryption-context - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - - name: x-amz-server-side-encryption-bucket-key-enabled - in: header - required: false - schema: - $ref: '#/components/schemas/BucketKeyEnabled' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSessionOutput' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: |- - The specified bucket does not exist. - /{Bucket}?analytics: - delete: - operationId: DeleteBucketAnalyticsConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about the Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). - - The following operations are related to `DeleteBucketAnalyticsConfiguration`: - - * [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) - - * [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) - - * [PutBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/AnalyticsId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - put: - operationId: PutBucketAnalyticsConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - `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`: - - * [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) - - * [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) - - * [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/AnalyticsId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/AnalyticsConfiguration' - responses: - '200': - description: Success - /{Bucket}?cors: - delete: - operationId: DeleteBucketCors - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the _Amazon S3 User Guide_. - - **Related Resources** - - * [PutBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) - - * [RESTOPTIONSobject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketCors - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - For more information about CORS, see [ Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html). - - The following operations are related to `GetBucketCors`: - - * [PutBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) - - * [DeleteBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketCorsOutput' - put: - operationId: PutBucketCors - description: "This operation is not supported for directory buckets.\n\nSets\ - \ the `cors` configuration for your bucket. If the configuration exists, Amazon\ - \ S3 replaces it.\n\nTo 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.\n\nYou 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.\n\nTo 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.\n\nWhen 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:\n\n * The request's `Origin`\ - \ header must match `AllowedOrigin` elements.\n\n * 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. \n\n * Every header specified in the `Access-Control-Request-Headers`\ - \ request header of a pre-flight request must match an `AllowedHeader` element.\ - \ \n\nFor more information about CORS, go to [Enabling Cross-Origin Resource\ - \ Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the\ - \ _Amazon S3 User Guide_.\n\nThe following operations are related to `PutBucketCors`:\n\ - \n * [GetBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html)\n\ - \n * [DeleteBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)\n\ - \n * [RESTOPTIONSobject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/CORSConfiguration' - responses: - '200': - description: Success - /{Bucket}?encryption: - delete: - operationId: DeleteBucketEncryption - description: "This implementation of the DELETE action resets the default encryption\ - \ for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).\n\ - \n * **General purpose buckets** \\- For information about the bucket default\ - \ encryption feature, see [Amazon S3 Bucket Default Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- For directory\ - \ buckets, there are only two supported options for server-side encryption:\ - \ SSE-S3 and SSE-KMS. For information about the default encryption configuration\ - \ in directory buckets, see [Setting default server-side encryption behavior\ - \ for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html).\n\ - \nPermissions\n\n \n\n * **General purpose bucket permissions** \\- The\ - \ `s3:PutEncryptionConfiguration` permission is required in a policy. 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 Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)\ - \ and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n\ - \n * **Directory bucket permissions** \\- To grant access to this API operation,\ - \ you must have the `s3express:PutEncryptionConfiguration` 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `DeleteBucketEncryption`:\n\n *\ - \ [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)\n\ - \n * [GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketEncryption - description: "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). This\ - \ operation also returns the [BucketKeyEnabled](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ServerSideEncryptionRule.html#AmazonS3-Type-ServerSideEncryptionRule-BucketKeyEnabled)\ - \ and [BlockedEncryptionTypes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ServerSideEncryptionRule.html#AmazonS3-Type-ServerSideEncryptionRule-BlockedEncryptionTypes)\ - \ statuses.\n\n * **General purpose buckets** \\- For information about the\ - \ bucket default encryption feature, see [Amazon S3 Bucket Default Encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- For directory\ - \ buckets, there are only two supported options for server-side encryption:\ - \ SSE-S3 and SSE-KMS. For information about the default encryption configuration\ - \ in directory buckets, see [Setting default server-side encryption behavior\ - \ for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html).\n\ - \nPermissions\n\n \n\n * **General purpose bucket permissions** \\- The\ - \ `s3:GetEncryptionConfiguration` permission is required in a policy. 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 Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)\ - \ and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n\ - \n * **Directory bucket permissions** \\- To grant access to this API operation,\ - \ you must have the `s3express:GetEncryptionConfiguration` 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `GetBucketEncryption`:\n\n * [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)\n\ - \n * [DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketEncryptionOutput' - put: - operationId: PutBucketEncryption - description: "This operation configures default encryption and Amazon S3 Bucket\ - \ Keys for an existing bucket. You can also [block encryption types](https://docs.aws.amazon.com/AmazonS3/latest/API/API_BlockedEncryptionTypes.html)\ - \ using this operation.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nBy default, all buckets have a default\ - \ encryption configuration that uses server-side encryption with Amazon S3\ - \ managed keys (SSE-S3).\n\n * **General purpose buckets**\n\n * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html).\ - \ For information about the bucket default encryption feature, see [Amazon\ - \ S3 Bucket Default Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)\ - \ in the _Amazon S3 User Guide_. \n\n * If you use PutBucketEncryption\ - \ to set your [default bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)\ - \ to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3\ - \ doesn't validate the KMS key ID provided in PutBucketEncryption requests.\n\ - \n * **Directory buckets** \\- You can optionally configure default encryption\ - \ for a bucket by using server-side encryption with Key Management Service\ - \ (KMS) keys (SSE-KMS).\n\n * We recommend that the bucket's default encryption\ - \ uses the desired encryption configuration and you don't override the bucket\ - \ default encryption in your `CreateSession` requests or `PUT` object requests.\ - \ Then, new objects are automatically encrypted with the desired encryption\ - \ settings. For more information about the encryption overriding behaviors\ - \ in directory buckets, see [Specifying server-side encryption with KMS for\ - \ new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\n\ - \n * Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ per directory bucket's lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\ - \ (`aws/s3`) isn't supported. \n\n * S3 Bucket Keys are always enabled\ - \ for `GET` and `PUT` operations in a directory bucket and can’t be disabled.\ - \ S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects\ - \ from general purpose buckets to directory buckets, from directory buckets\ - \ to general purpose buckets, or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html),\ - \ [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html),\ - \ [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops),\ - \ or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job).\ - \ In this case, Amazon S3 makes a call to KMS every time a copy request is\ - \ made for a KMS-encrypted object.\n\n * When you specify an [KMS customer\ - \ managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ for encryption in your directory bucket, only use the key ID or key ARN.\ - \ The key alias format of the KMS key isn't supported.\n\n * For directory\ - \ buckets, if you use PutBucketEncryption to set your [default bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)\ - \ to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption\ - \ requests.\n\nIf you're specifying a customer managed KMS key, we recommend\ - \ using a fully qualified KMS key ARN. If you use a KMS key alias instead,\ - \ then KMS resolves the key within the requester’s account. This behavior\ - \ can result in data that's encrypted with a KMS key that belongs to the requester,\ - \ and not the bucket owner.\n\nAlso, this action requires Amazon Web Services\ - \ Signature Version 4. For more information, see [ Authenticating Requests\ - \ (Amazon Web Services Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).\n\ - \nPermissions\n\n \n\n * **General purpose bucket permissions** \\- The\ - \ `s3:PutEncryptionConfiguration` permission is required in a policy. 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 Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)\ - \ and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - To grant access to this API operation, you must have the `s3express:PutEncryptionConfiguration`\ - \ 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nTo set a directory bucket default encryption\ - \ with SSE-KMS, you must also have the `kms:GenerateDataKey` and the `kms:Decrypt`\ - \ permissions in IAM identity-based policies and KMS key policies for the\ - \ target KMS key.\n\nHTTP Host header syntax\n\n \n\n**Directory buckets**\ - \ \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `PutBucketEncryption`:\n\n * [GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)\n\ - \n * [DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/ServerSideEncryptionConfiguration' - responses: - '200': - description: Success - /{Bucket}?intelligent-tiering: - delete: - operationId: DeleteBucketIntelligentTieringConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). - - Operations related to `DeleteBucketIntelligentTieringConfiguration` include: - - * [GetBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) - - * [PutBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) - - * [ListBucketIntelligentTieringConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/IntelligentTieringId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - put: - operationId: PutBucketIntelligentTieringConfiguration - description: "This operation is not supported for directory buckets.\n\nPuts\ - \ a S3 Intelligent-Tiering configuration to the specified bucket. You can\ - \ have up to 1,000 S3 Intelligent-Tiering configurations per bucket.\n\nThe\ - \ 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.\n\ - \nThe 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.\n\nFor more information, see\ - \ [Storage class for automatically optimizing frequently and infrequently\ - \ accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).\n\ - \nOperations related to `PutBucketIntelligentTieringConfiguration` include:\n\ - \n * [DeleteBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)\n\ - \n * [GetBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)\n\ - \n * [ListBucketIntelligentTieringConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)\n\ - \nYou 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.\n\n`PutBucketIntelligentTieringConfiguration`\ - \ has the following special errors:\n\nHTTP 400 Bad Request Error\n\n \n\ - \n_Code:_ InvalidArgument\n\n_Cause:_ Invalid Argument\n\nHTTP 400 Bad Request\ - \ Error\n\n \n\n_Code:_ TooManyConfigurations\n\n_Cause:_ You are attempting\ - \ to create a new configuration but have already reached the 1,000-configuration\ - \ limit.\n\nHTTP 403 Forbidden Error\n\n \n\n_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.\n\nYou must URL\ - \ encode any signed header values that contain spaces. For example, if your\ - \ header value is `my file.txt`, containing two spaces after `my`, you must\ - \ URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/IntelligentTieringId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/IntelligentTieringConfiguration' - responses: - '200': - description: Success - /{Bucket}?inventory: - delete: - operationId: DeleteBucketInventoryConfiguration - description: |- - This operation is not supported for directory buckets. - - Deletes an S3 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). - - Operations related to `DeleteBucketInventoryConfiguration` include: - - * [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) - - * [PutBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) - - * [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/InventoryId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - put: - operationId: PutBucketInventoryConfiguration - description: "This operation is not supported for directory buckets.\n\nThis\ - \ implementation of the `PUT` action adds an S3 Inventory configuration (identified\ - \ by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations\ - \ per bucket.\n\nAmazon 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.\n\nWhen 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html)\ - \ in the Amazon S3 User Guide.\n\nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).\n\ - \nPermissions\n\n \n\nTo 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.\n\n\ - The `s3:PutInventoryConfiguration` permission allows a user to create an [S3\ - \ Inventory](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html)\ - \ 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.\n\nTo restrict access to an\ - \ inventory report, see [Restricting access to an Amazon S3 Inventory report](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10)\ - \ in the _Amazon S3 User Guide_. For more information about the metadata fields\ - \ available in S3 Inventory, see [Amazon S3 Inventory lists](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents)\ - \ in the _Amazon S3 User Guide_. For more information about permissions, see\ - \ [Permissions related to bucket subresource operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)\ - \ and [Identity and access management in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)\ - \ in the _Amazon S3 User Guide_.\n\n`PutBucketInventoryConfiguration` has\ - \ the following special errors:\n\nHTTP 400 Bad Request Error\n\n \n\n\ - _Code:_ InvalidArgument\n\n_Cause:_ Invalid Argument\n\nHTTP 400 Bad Request\ - \ Error\n\n \n\n_Code:_ TooManyConfigurations\n\n_Cause:_ You are attempting\ - \ to create a new configuration but have already reached the 1,000-configuration\ - \ limit.\n\nHTTP 403 Forbidden Error\n\n \n\n_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.\n\nThe following\ - \ operations are related to `PutBucketInventoryConfiguration`:\n\n * [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)\n\ - \n * [DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)\n\ - \n * [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/InventoryId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/InventoryConfiguration' - responses: - '200': - description: Success - /{Bucket}?lifecycle: - delete: - operationId: DeleteBucketLifecycle - description: "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.\n\nPermissions\n\n \n\n * **General\ - \ purpose bucket 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 have\ - \ the `s3:PutLifecycleConfiguration` permission.\n\nFor more information about\ - \ permissions, see [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n\ - \n * **Directory bucket permissions** \\- You must have the `s3express:PutLifecycleConfiguration`\ - \ permission in an IAM identity-based policy to use this operation. Cross-account\ - \ access to this API operation isn't supported. The resource owner can optionally\ - \ grant access permissions to others by creating a role or user for them as\ - \ long as they are within the same account as the owner and resource.\n\n\ - For more information about directory bucket policies and permissions, see\ - \ [Authorizing Regional endpoint APIs with IAM](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region_.amazonaws.com`.\n\ - \nFor more information about the object expiration, see [Elements to Describe\ - \ Lifecycle Actions](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).\n\ - \nRelated actions include:\n\n * [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)\n\ - \n * [GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketLifecycleConfiguration - description: "Returns the lifecycle configuration information set on the bucket.\ - \ For information about lifecycle configuration, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html).\n\ - \nBucket lifecycle configuration now supports specifying a lifecycle rule\ - \ using an object key name prefix, one or more object tags, object size, or\ - \ any combination of these. Accordingly, this section describes the latest\ - \ API, which is compatible with the new functionality. The previous version\ - \ of the API supported filtering based only on an object key name prefix,\ - \ which is supported for general purpose buckets for backward compatibility.\ - \ For the related API description, see [GetBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html).\n\ - \nLifecyle configurations for directory buckets only support expiring objects\ - \ and cancelling multipart uploads. Expiring of versioned objects, transitions\ - \ and tag filters are not supported.\n\nPermissions\n\n \n\n * **General\ - \ purpose bucket 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 have\ - \ the `s3:GetLifecycleConfiguration` permission.\n\nFor more information about\ - \ permissions, see [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n\ - \n * **Directory bucket permissions** \\- You must have the `s3express:GetLifecycleConfiguration`\ - \ permission in an IAM identity-based policy to use this operation. Cross-account\ - \ access to this API operation isn't supported. The resource owner can optionally\ - \ grant access permissions to others by creating a role or user for them as\ - \ long as they are within the same account as the owner and resource.\n\n\ - For more information about directory bucket policies and permissions, see\ - \ [Authorizing Regional endpoint APIs with IAM](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region_.amazonaws.com`.\n\ - \n`GetBucketLifecycleConfiguration` has the following special error:\n\n \ - \ * Error code: `NoSuchLifecycleConfiguration`\n\n * Description: The lifecycle\ - \ configuration does not exist.\n\n * HTTP Status Code: 404 Not Found\n\ - \n * SOAP Fault Code Prefix: Client\n\nThe following operations are related\ - \ to `GetBucketLifecycleConfiguration`:\n\n * [GetBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)\n\ - \n * [PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)\n\ - \n * [DeleteBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLifecycleConfigurationOutput' - put: - operationId: PutBucketLifecycleConfiguration - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html).\n\ - \nBucket lifecycle configuration now supports specifying a lifecycle rule\ - \ using an object key name prefix, one or more object tags, object size, or\ - \ any combination of these. 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html).\n\ - \nRules\n\nPermissions\n\nHTTP Host header syntax\n\n \n\nYou 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.\n\ - \nBucket lifecycle configuration supports specifying a lifecycle rule using\ - \ an object key name prefix, one or more object tags, object size, or any\ - \ combination of these. 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 general\ - \ purpose buckets. For the related API description, see [PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html).\n\ - \nLifecyle configurations for directory buckets only support expiring objects\ - \ and cancelling multipart uploads. Expiring of versioned objects,transitions\ - \ and tag filters are not supported.\n\nA lifecycle rule consists of the following:\n\ - \n * A filter identifying a subset of objects to which the rule applies.\ - \ The filter can be based on a key name prefix, object tags, object size,\ - \ or any combination of these.\n\n * A status indicating whether the rule\ - \ is in effect.\n\n * 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.\n\nFor more\ - \ information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)\ - \ and [Lifecycle Configuration Elements](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html).\n\ - \n \n\n * **General purpose bucket 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 have the `s3:PutLifecycleConfiguration` permission.\n\nYou 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:\n\n * `s3:DeleteObject`\n\n * `s3:DeleteObjectVersion`\n\n\ - \ * `s3:PutLifecycleConfiguration`\n\nFor more information about permissions,\ - \ see [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n\ - \n * **Directory bucket permissions** \\- You must have the `s3express:PutLifecycleConfiguration`\ - \ permission in an IAM identity-based policy to use this operation. Cross-account\ - \ access to this API operation isn't supported. The resource owner can optionally\ - \ grant access permissions to others by creating a role or user for them as\ - \ long as they are within the same account as the owner and resource.\n\n\ - For more information about directory bucket policies and permissions, see\ - \ [Authorizing Regional endpoint APIs with IAM](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\n \n\n**Directory buckets** \\- The\ - \ HTTP Host header syntax is `s3express-control._region_.amazonaws.com`.\n\ - \nThe following operations are related to `PutBucketLifecycleConfiguration`:\n\ - \n * [GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)\n\ - \n * [DeleteBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-transition-default-minimum-object-size - in: header - required: false - schema: - $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/BucketLifecycleConfiguration' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutBucketLifecycleConfigurationOutput' - /{Bucket}?metrics: - delete: - operationId: DeleteBucketMetricsConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). - - The following operations are related to `DeleteBucketMetricsConfiguration`: - - * [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) - - * [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) - - * [ListBucketMetricsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) - - * [Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/MetricsId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - put: - operationId: PutBucketMetricsConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). - - The following operations are related to `PutBucketMetricsConfiguration`: - - * [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) - - * [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) - - * [ListBucketMetricsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) - - `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 - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/MetricsId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/MetricsConfiguration' - responses: - '200': - description: Success - /{Bucket}?ownershipControls: - delete: - operationId: DeleteBucketOwnershipControls - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). - - For information about Amazon S3 Object Ownership, see [Using Object Ownership](https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html). - - The following operations are related to `DeleteBucketOwnershipControls`: - - * GetBucketOwnershipControls - - * PutBucketOwnershipControls - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketOwnershipControls - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html). - - A bucket doesn't have `OwnershipControls` settings in the following cases: - - * The bucket was created before the `BucketOwnerEnforced` ownership setting was introduced and you've never explicitly applied this value - - * You've manually deleted the bucket ownership control value using the `DeleteBucketOwnershipControls` API operation. - - By default, Amazon S3 sets `OwnershipControls` for all newly created buckets. - - For information about Amazon S3 Object Ownership, see [Using Object Ownership](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html). - - The following operations are related to `GetBucketOwnershipControls`: - - * PutBucketOwnershipControls - - * DeleteBucketOwnershipControls - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketOwnershipControlsOutput' - put: - operationId: PutBucketOwnershipControls - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html). - - For information about Amazon S3 Object Ownership, see [Using object ownership](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html). - - The following operations are related to `PutBucketOwnershipControls`: - - * GetBucketOwnershipControls - - * DeleteBucketOwnershipControls - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/OwnershipControls' - responses: - '200': - description: Success - /{Bucket}?policy: - delete: - operationId: DeleteBucketPolicy - description: "Deletes the policy of a specified bucket.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nIf 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.\n\nIf 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.\n\nTo 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.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `DeleteBucketPolicy`\n\n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \n * [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketPolicy - description: "Returns the policy of a specified bucket.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nIf 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.\n\nIf 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.\n\nTo 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.\n\ - \n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nExample bucket policies\n\n \n\n**General\ - \ purpose buckets example bucket policies** \\- See [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\n**Directory bucket example bucket policies**\ - \ \\- See [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following action is related to `GetBucketPolicy`:\n\n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketPolicyOutput' - put: - operationId: PutBucketPolicy - description: "Applies an Amazon S3 bucket policy to an Amazon S3 bucket.\n\n\ - **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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nIf 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.\n\nIf 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.\n\nTo 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.\n\ - \n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nExample bucket policies\n\n \n\n**General\ - \ purpose buckets example bucket policies** \\- See [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\n**Directory bucket example bucket policies**\ - \ \\- See [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `PutBucketPolicy`:\n\n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \n * [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-confirm-remove-self-bucket-access - in: header - required: false - schema: - $ref: '#/components/schemas/ConfirmRemoveSelfBucketAccess' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/Policy' - responses: - '200': - description: Success - /{Bucket}?replication: - delete: - operationId: DeleteBucketReplication - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - It can take a while for the deletion of a replication configuration to fully propagate. - - For information about replication configuration, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the _Amazon S3 User Guide_. - - The following operations are related to `DeleteBucketReplication`: - - * [PutBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) - - * [GetBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketReplication - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) - - The following operations are related to `GetBucketReplication`: - - * [PutBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) - - * [DeleteBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketReplicationOutput' - put: - operationId: PutBucketReplication - description: "This operation is not supported for directory buckets.\n\nCreates\ - \ a replication configuration or replaces an existing one. For more information,\ - \ see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html)\ - \ in the _Amazon S3 User Guide_.\n\nSpecify 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`\ - \ ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion)\ - \ condition key.\n\nA 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.\n\ - \nTo 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`.\n\ - \nIf you are using an earlier version of the replication configuration, Amazon\ - \ S3 handles replication of delete markers differently. For more information,\ - \ see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).\n\ - \nFor information about enabling versioning on a bucket, see [Using Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).\n\ - \nHandling Replication of Encrypted Objects\n\n \n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html).\n\ - \nFor information on `PutBucketReplication` errors, see [List of replication-related\ - \ error codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)\n\ - \nPermissions\n\n \n\nTo create a `PutBucketReplication` request, you must\ - \ have `s3:PutReplicationConfiguration` permissions for the bucket.\n\nBy\ - \ 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)\ - \ and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n\ - \nTo perform this operation, the user or role performing the action must have\ - \ the [iam:PassRole](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html)\ - \ permission.\n\nThe following operations are related to `PutBucketReplication`:\n\ - \n * [GetBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)\n\ - \n * [DeleteBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-bucket-object-lock-token - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockToken' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/ReplicationConfiguration' - responses: - '200': - description: Success - /{Bucket}?tagging: - delete: - operationId: DeleteBucketTagging - description: |- - This operation is not supported for directory buckets. - - Deletes tags from the general purpose bucket if attribute based access control (ABAC) is not enabled for the bucket. When you [enable ABAC for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html), you can no longer use this operation for that bucket and must use [UntagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UntagResource.html) instead. - - if ABAC is not enabled for the bucket. When you [enable ABAC for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html), you can no longer use this operation for that bucket and must use [UntagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UntagResource.html) instead. - - 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`: - - * [GetBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) - - * [PutBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketTagging - description: |- - This operation is not supported for directory buckets. - - Returns the tag set associated with the general purpose bucket. - - if ABAC is not enabled for the bucket. When you [enable ABAC for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html), you can no longer use this operation for that bucket and must use [ListTagsForResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListTagsForResource.html) instead. - - 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`: - - * [PutBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) - - * [DeleteBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketTaggingOutput' - put: - operationId: PutBucketTagging - description: |- - This operation is not supported for directory buckets. - - Sets the tags for a general purpose bucket if attribute based access control (ABAC) is not enabled for the bucket. When you [enable ABAC for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html), you can no longer use this operation for that bucket and must use the [TagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_TagResource.html) or [UntagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UntagResource.html) operations instead. - - 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](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) and [Using Cost Allocation in Amazon S3 Bucket Tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - `PutBucketTagging` has the following special errors. For more Amazon S3 errors see, [Error Responses](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html). - - * `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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html). - - * `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`: - - * [GetBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) - - * [DeleteBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/Tagging' - responses: - '200': - description: Success - /{Bucket}?website: - delete: - operationId: DeleteBucketWebsite - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). - - The following operations are related to `DeleteBucketWebsite`: - - * [GetBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html) - - * [PutBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetBucketWebsite - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). - - 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`: - - * [DeleteBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html) - - * [PutBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketWebsiteOutput' - put: - operationId: PutBucketWebsite - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in the _Amazon S3 User Guide_. - - The maximum request length is limited to 128 KB. - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/WebsiteConfiguration' - responses: - '200': - description: Success - /{Bucket}/{Key+}?x-id=DeleteObject: - delete: - operationId: DeleteObject - description: "Removes an object from a bucket. The behavior depends on the bucket's\ - \ versioning state:\n\n * If bucket versioning is not enabled, the operation\ - \ permanently deletes the object.\n\n * If bucket versioning is enabled,\ - \ the operation inserts a delete marker, which becomes the current version\ - \ of the object. To permanently delete an object in a versioned bucket, you\ - \ must include the object’s `versionId` in the request. For more information\ - \ about versioning-enabled buckets, see [Deleting object versions from a versioning-enabled\ - \ bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html).\n\ - \n * If bucket versioning is suspended, the operation removes the object\ - \ that has a null `versionId`, if there is one, and inserts a delete marker\ - \ that becomes the current version of the object. If there isn't an object\ - \ with a null `versionId`, and all versions of the object have a `versionId`,\ - \ Amazon S3 does not remove the object and only inserts a delete marker. To\ - \ permanently delete an object that has a `versionId`, you must include the\ - \ object’s `versionId` in the request. For more information about versioning-suspended\ - \ buckets, see [Deleting objects from versioning-suspended buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html).\n\ - \n * **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.\n\n * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nTo 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.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html)\ - \ in the _Amazon S3 User Guide_. To see sample requests that use versioning,\ - \ see [Sample Request](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete).\n\ - \n**Directory buckets** \\- MFA delete is not supported by directory buckets.\n\ - \nYou can delete objects by explicitly calling DELETE Object or calling ([PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html))\ - \ 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.\n\n**Directory buckets** \\- S3 Lifecycle is not supported by directory\ - \ buckets.\n\nPermissions\n\n \n\n * **General purpose bucket permissions**\ - \ \\- The following permissions are required in your policies when your `DeleteObjects`\ - \ request includes specific headers.\n\n * **`s3:DeleteObject` ** \\- To\ - \ delete an object from a bucket, you must always have the `s3:DeleteObject`\ - \ permission.\n\n * **`s3:DeleteObjectVersion` ** \\- To delete a specific\ - \ version of an object from a versioning-enabled bucket, you must have the\ - \ `s3:DeleteObjectVersion` permission.\n\nIf the `s3:DeleteObject` or `s3:DeleteObjectVersion`\ - \ permissions are explicitly denied in your bucket policy, attempts to delete\ - \ any unversioned objects result in a `403 Access Denied` error.\n\n * **Directory\ - \ bucket permissions** \\- To grant access to this API operation on a directory\ - \ bucket, we recommend that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nHTTP Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host\ - \ header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following action is related to `DeleteObject`:\n\n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`.\n\nThe `If-Match`\ - \ header is supported for both general purpose and directory buckets. `IfMatchLastModifiedTime`\ - \ and `IfMatchSize` is only supported for directory buckets." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-mfa - in: header - required: false - schema: - $ref: '#/components/schemas/MFA' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-bypass-governance-retention - in: header - required: false - schema: - $ref: '#/components/schemas/BypassGovernanceRetention' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: If-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatch' - - name: x-amz-if-match-last-modified-time - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatchLastModifiedTime' - - name: x-amz-if-match-size - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatchSize' - responses: - '204': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteObjectOutput' - /{Bucket}/{Key+}?tagging: - delete: - operationId: DeleteObjectTagging - description: |- - This operation is not supported for directory buckets. - - Removes the entire tag set from the specified object. For more information about managing object tags, see [ Object Tagging](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). - - 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`: - - * [PutObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) - - * [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteObjectTaggingOutput' - get: - operationId: GetObjectTagging - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). - - The following actions are related to `GetObjectTagging`: - - * [DeleteObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) - - * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) - - * [PutObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectTaggingOutput' - put: - operationId: PutObjectTagging - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html). - - For tagging-related restrictions related to characters and encodings, see [Tag Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html). 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html). - - * `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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html). - - * `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`: - - * [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) - - * [DeleteObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/Tagging' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectTaggingOutput' - /{Bucket}?delete: - post: - operationId: DeleteObjects - description: "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.\n\nThe request can contain\ - \ a list of up to 1,000 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. If the object specified in\ - \ the request isn't found, Amazon S3 confirms the deletion by returning the\ - \ result as deleted.\n\n * **Directory buckets** \\- S3 Versioning isn't\ - \ enabled and supported for directory buckets.\n\n * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe 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.\n\nWhen 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete)\ - \ in the _Amazon S3 User Guide_.\n\n**Directory buckets** \\- MFA delete is\ - \ not supported by directory buckets.\n\nPermissions\n\n \n\n * **General\ - \ purpose bucket permissions** \\- The following permissions are required\ - \ in your policies when your `DeleteObjects` request includes specific headers.\n\ - \n * **`s3:DeleteObject` ** \\- To delete an object from a bucket, you\ - \ must always specify the `s3:DeleteObject` permission.\n\n * **`s3:DeleteObjectVersion`\ - \ ** \\- To delete a specific version of an object from a versioning-enabled\ - \ bucket, you must specify the `s3:DeleteObjectVersion` permission.\n\nIf\ - \ the `s3:DeleteObject` or `s3:DeleteObjectVersion` permissions are explicitly\ - \ denied in your bucket policy, attempts to delete any unversioned objects\ - \ result in a `403 Access Denied` error.\n\n * **Directory bucket permissions**\ - \ \\- To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nContent-MD5 request header\n\n \n\n * **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.\n\n * **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.\n\nHTTP Host header syntax\n\ - \n \n\n**Directory buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `DeleteObjects`:\n\n * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-mfa - in: header - required: false - schema: - $ref: '#/components/schemas/MFA' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-bypass-governance-retention - in: header - required: false - schema: - $ref: '#/components/schemas/BypassGovernanceRetention' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/Delete' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteObjectsOutput' - /{Bucket}?publicAccessBlock: - delete: - operationId: DeletePublicAccessBlock - description: |- - This operation is not supported for directory buckets. - - Removes the `PublicAccessBlock` configuration for an Amazon S3 bucket. This operation removes the bucket-level configuration only. The effective public access behavior will still be governed by account-level settings (which may inherit from organization-level policies). To use this operation, you must have the `s3:PutBucketPublicAccessBlock` permission. For more information about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - The following operations are related to `DeletePublicAccessBlock`: - - * [Using Amazon S3 Block Public Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) - - * [GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) - - * [PutPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) - - * [GetBucketPolicyStatus](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '204': - description: Success - get: - operationId: GetPublicAccessBlock - description: |- - This operation is not supported for directory buckets. - - Retrieves the `PublicAccessBlock` configuration for an Amazon S3 bucket. This operation returns the bucket-level configuration only. To understand the effective public access behavior, you must also consider account-level settings (which may inherit from organization-level policies). To use this operation, you must have the `s3:GetBucketPublicAccessBlock` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). - - 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. Account-level settings automatically inherit from organization-level policies when present. 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"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). - - The following operations are related to `GetPublicAccessBlock`: - - * [Using Amazon S3 Block Public Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) - - * [PutPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) - - * [GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) - - * [DeletePublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPublicAccessBlockOutput' - put: - operationId: PutPublicAccessBlock - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). - - 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. Account-level settings automatically inherit from organization-level policies when present. 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"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). - - The following operations are related to `PutPublicAccessBlock`: - - * [GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) - - * [DeletePublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) - - * [GetBucketPolicyStatus](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) - - * [Using Amazon S3 Block Public Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/PublicAccessBlockConfiguration' - responses: - '200': - description: Success - /?abac: - servers: - - url: 'https://{Bucket}.s3-{region}.amazonaws.com' - variables: - Bucket: - default: stackql-trial-bucket-02 - region: - default: us-east-1 - get: - operationId: GetBucketAbac - description: |- - Returns the attribute-based access control (ABAC) property of the general purpose bucket. If ABAC is enabled on your bucket, you can use tags on the bucket for access control. For more information, see [Enabling ABAC in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html). - parameters: - - name: x-amz-content-sha256 - in: header - required: false - schema: - type: string - default: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAbacOutput' - put: - operationId: PutBucketAbac - description: |- - Sets the attribute-based access control (ABAC) property of the general purpose bucket. You must have `s3:PutBucketABAC` permission to perform this action. When you enable ABAC, you can use tags for access control on your buckets. Additionally, when ABAC is enabled, you must use the [TagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_TagResource.html) and [UntagResource](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UntagResource.html) actions to manage tags on your buckets. You can nolonger use the [PutBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) and [DeleteBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) actions to tag your bucket. For more information, see [Enabling ABAC in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html). - parameters: - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/AbacStatus' - responses: - '200': - description: Success - /{Bucket}?accelerate: - get: - operationId: GetBucketAccelerateConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the _Amazon S3 User Guide_. - - You set the Transfer Acceleration state of an existing bucket to `Enabled` or `Suspended` by using the [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the Amazon S3 User Guide. - - The following operations are related to `GetBucketAccelerateConfiguration`: - - * [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAccelerateConfigurationOutput' - put: - operationId: PutBucketAccelerateConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html). - - The following operations are related to `PutBucketAccelerateConfiguration`: - - * [GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) - - * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/AccelerateConfiguration' - responses: - '200': - description: Success - /{Bucket}?acl: - get: - operationId: GetBucketAcl - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the _Amazon S3 User Guide_. - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - - The following operations are related to `GetBucketAcl`: - - * [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAclOutput' - put: - operationId: PutBucketAcl - description: "End of support notice: As of October 1, 2025, Amazon S3 has discontinued\ - \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ - \ use an Email Grantee ACL in a request after October 1, 2025, the request\ - \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ - \ 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), and South America (São\ - \ Paulo).\n\nThis operation is not supported for directory buckets.\n\nSets\ - \ the permissions on an existing bucket using access control lists (ACL).\ - \ For more information, see [Using ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).\ - \ To set the ACL of a bucket, you must have the `WRITE_ACP` permission.\n\n\ - You can use one of the following two ways to set a bucket's permissions:\n\ - \n * Specify the ACL in the request body\n\n * Specify permissions using\ - \ request headers\n\nYou cannot specify access permission using both the body\ - \ and the request headers.\n\nDepending 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.\n\n\ - 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nYou can set access\ - \ permissions by using one of the following methods:\n\n * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).\n\ - \n * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).\n\ - \nYou specify each grantee as a type=value pair, where the type is one of\ - \ the following:\n\n * `id` – if the value specified is the canonical user\ - \ ID of an Amazon Web Services account\n\n * `uri` – if you are granting\ - \ permissions to a predefined group\n\n * `emailAddress` – if the value\ - \ specified is the email address of an Amazon Web Services account\n\nUsing\ - \ email addresses to specify a grantee is only supported in the following\ - \ Amazon Web Services Regions:\n\n * US East (N. Virginia)\n\n *\ - \ US West (N. California)\n\n * US West (Oregon)\n\n * Asia Pacific\ - \ (Singapore)\n\n * Asia Pacific (Sydney)\n\n * Asia Pacific (Tokyo)\n\ - \n * Europe (Ireland)\n\n * South America (São Paulo)\n\nFor a list\ - \ of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nFor 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.\n\n`x-amz-grant-write:\ - \ uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\"\ - , id=\"555566667777\" `\n\nYou can use either a canned ACL or specify access\ - \ permissions explicitly. You cannot do both.\n\nGrantee Values\n\n \n\n\ - You can specify the person (grantee) to whom you're assigning access rights\ - \ (using request elements) in the following ways. For examples of how to specify\ - \ these grantee values in JSON format, see the Amazon Web Services CLI example\ - \ in [ Enabling Amazon S3 server access logging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html)\ - \ in the _Amazon S3 User Guide_.\n\n * By the person's ID:\n\n`<>ID<><>GranteesEmail<>\ - \ `\n\nDisplayName is optional and ignored in the request\n\n * By URI:\n\ - \n`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`\n\n * By\ - \ Email address:\n\n`<>Grantees@email.com<>&`\n\nThe grantee is resolved to\ - \ the CanonicalUser and, in a response to a GET Object acl request, appears\ - \ as the CanonicalUser.\n\nUsing email addresses to specify a grantee is only\ - \ supported in the following Amazon Web Services Regions:\n\n * US East\ - \ (N. Virginia)\n\n * US West (N. California)\n\n * US West (Oregon)\n\ - \n * Asia Pacific (Singapore)\n\n * Asia Pacific (Sydney)\n\n * Asia\ - \ Pacific (Tokyo)\n\n * Europe (Ireland)\n\n * South America (São Paulo)\n\ - \nFor a list of all the Amazon S3 supported Regions and endpoints, see [Regions\ - \ and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nThe following operations\ - \ are related to `PutBucketAcl`:\n\n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \n * [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n\ - \n * [GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-acl - in: header - required: false - schema: - $ref: '#/components/schemas/BucketCannedACL' - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-grant-full-control - in: header - required: false - schema: - $ref: '#/components/schemas/GrantFullControl' - - name: x-amz-grant-read - in: header - required: false - schema: - $ref: '#/components/schemas/GrantRead' - - name: x-amz-grant-read-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantReadACP' - - name: x-amz-grant-write - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWrite' - - name: x-amz-grant-write-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWriteACP' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/AccessControlPolicy' - responses: - '200': - description: Success - /{Bucket}?analytics&x-id=GetBucketAnalyticsConfiguration: - get: - operationId: GetBucketAnalyticsConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the _Amazon S3 User Guide_. - - For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) in the _Amazon S3 User Guide_. - - The following operations are related to `GetBucketAnalyticsConfiguration`: - - * [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) - - * [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) - - * [PutBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/AnalyticsId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAnalyticsConfigurationOutput' - /{Bucket}?intelligent-tiering&x-id=GetBucketIntelligentTieringConfiguration: - get: - operationId: GetBucketIntelligentTieringConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). - - Operations related to `GetBucketIntelligentTieringConfiguration` include: - - * [DeleteBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) - - * [PutBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) - - * [ListBucketIntelligentTieringConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/IntelligentTieringId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketIntelligentTieringConfigurationOutput' - /{Bucket}?inventory&x-id=GetBucketInventoryConfiguration: - get: - operationId: GetBucketInventoryConfiguration - description: |- - This operation is not supported for directory buckets. - - Returns an S3 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). - - The following operations are related to `GetBucketInventoryConfiguration`: - - * [DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) - - * [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) - - * [PutBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/InventoryId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketInventoryConfigurationOutput' - /?location: - servers: - - url: https://{Bucket}.s3.{region}.amazonaws.com - variables: - region: - default: us-east-1 - Bucket: - default: example-bucket - get: - operationId: GetBucketLocation - description: |- - Using the `GetBucketLocation` operation is no longer a best practice. To return the Region that a bucket resides in, we recommend that you use the [HeadBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html) operation instead. For backward compatibility, Amazon S3 continues to support the `GetBucketLocation` operation. - - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). - - In a bucket's home Region, calls to the `GetBucketLocation` operation are governed by the bucket's policy. In other Regions, the bucket policy doesn't apply, which means that cross-account access won't be authorized. However, calls to the `HeadBucket` operation always return the bucket’s location through an HTTP response header, whether access to the bucket is authorized or not. Therefore, we recommend using the `HeadBucket` operation for bucket Region discovery and to avoid using the `GetBucketLocation` operation. - - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - This operation is not supported for directory buckets. - - The following operations are related to `GetBucketLocation`: - - * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) - - * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: x-amz-content-sha256 - in: header - required: false - schema: - type: string - default: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLocationOutput' - /{Bucket}?logging: - get: - operationId: GetBucketLogging - description: |- - This operation is not supported for 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`: - - * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) - - * [PutBucketLogging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLoggingOutput' - put: - operationId: PutBucketLogging - description: "End of support notice: As of October 1, 2025, Amazon S3 has discontinued\ - \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ - \ use an Email Grantee ACL in a request after October 1, 2025, the request\ - \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ - \ 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), and South America (São\ - \ Paulo).\n\nThis operation is not supported for directory buckets.\n\nSet\ - \ 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.\n\nThe 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.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general)\ - \ in the _Amazon S3 User Guide_.\n\nGrantee Values\n\n \n\nYou can specify\ - \ the person (grantee) to whom you're assigning access rights (by using request\ - \ elements) in the following ways. For examples of how to specify these grantee\ - \ values in JSON format, see the Amazon Web Services CLI example in [ Enabling\ - \ Amazon S3 server access logging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html)\ - \ in the _Amazon S3 User Guide_.\n\n * By the person's ID:\n\n`<>ID<><>GranteesEmail<>\ - \ `\n\n`DisplayName` is optional and ignored in the request.\n\n * By Email\ - \ address:\n\n` <>Grantees@email.com<>`\n\nThe grantee is resolved to the\ - \ `CanonicalUser` and, in a response to a `GETObjectAcl` request, appears\ - \ as the CanonicalUser.\n\n * By URI:\n\n`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`\n\ - \nTo enable logging, you use `LoggingEnabled` and its children request elements.\ - \ To disable logging, you use an empty `BucketLoggingStatus` request element:\n\ - \n``\n\nFor more information about server access logging, see [Server Access\ - \ Logging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html)\ - \ in the _Amazon S3 User Guide_.\n\nFor more information about creating a\ - \ bucket, see [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html).\ - \ For more information about returning the logging status of a bucket, see\ - \ [GetBucketLogging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html).\n\ - \nThe following operations are related to `PutBucketLogging`:\n\n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \n * [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n\ - \n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \n * [GetBucketLogging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/BucketLoggingStatus' - responses: - '200': - description: Success - /{Bucket}?metrics&x-id=GetBucketMetricsConfiguration: - get: - operationId: GetBucketMetricsConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). - - The following operations are related to `GetBucketMetricsConfiguration`: - - * [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) - - * [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) - - * [ListBucketMetricsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) - - * [Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: id - in: query - required: true - schema: - $ref: '#/components/schemas/MetricsId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketMetricsConfigurationOutput' - /{Bucket}?notification: - get: - operationId: GetBucketNotificationConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - For more information about setting and reading the notification configuration on a bucket, see [Setting Up Notification of Bucket Events](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). For more information about bucket policies, see [Using Bucket Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). - - The following action is related to `GetBucketNotification`: - - * [PutBucketNotification](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/NotificationConfiguration' - put: - operationId: PutBucketNotificationConfiguration - description: |- - This operation is not supported for directory buckets. - - Enables notifications of specified events for a bucket. For more information about event notifications, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). - - 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`. - - `` - - `` - - 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). - - 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](https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3) 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`: - - * [GetBucketNotificationConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-skip-destination-validation - in: header - required: false - schema: - $ref: '#/components/schemas/SkipValidation' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/NotificationConfiguration' - responses: - '200': - description: Success - /{Bucket}?policyStatus: - get: - operationId: GetBucketPolicyStatus - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). - - For more information about when Amazon S3 considers a bucket public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). - - The following operations are related to `GetBucketPolicyStatus`: - - * [Using Amazon S3 Block Public Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) - - * [GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) - - * [PutPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) - - * [DeletePublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketPolicyStatusOutput' - /{Bucket}?requestPayment: - get: - operationId: GetBucketRequestPayment - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). - - The following operations are related to `GetBucketRequestPayment`: - - * [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketRequestPaymentOutput' - put: - operationId: PutBucketRequestPayment - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). - - The following operations are related to `PutBucketRequestPayment`: - - * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) - - * [GetBucketRequestPayment](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/RequestPaymentConfiguration' - responses: - '200': - description: Success - /{Bucket}?versioning: - get: - operationId: GetBucketVersioning - description: |- - This operation is not supported for 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`: - - * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) - - * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) - - * [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketVersioningOutput' - put: - operationId: PutBucketVersioning - description: |- - This operation is not supported for directory buckets. - - When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you might encounter intermittent `HTTP 404 NoSuchKey` errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (`PUT` or `DELETE`) on objects in the bucket. - - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config). - - The following operations are related to `PutBucketVersioning`: - - * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) - - * [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) - - * [GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-mfa - in: header - required: false - schema: - $ref: '#/components/schemas/MFA' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/VersioningConfiguration' - responses: - '200': - description: Success - /{Bucket}/{Key+}?x-id=GetObject: - get: - operationId: GetObject - description: "Retrieves an object from Amazon S3.\n\nIn the `GetObject` request,\ - \ specify the full key name for the object.\n\n**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](https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket)\ - \ in the _Amazon S3 User Guide_.\n\n**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 `amzn-s3-demo-bucket--usw2-az1--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-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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.\n\nIf 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.\n\ - \nIf the object that you request doesn’t exist, the error that Amazon S3 returns\ - \ depends on whether you also have the `s3:ListBucket` permission.\n\n \ - \ * If you have the `s3:ListBucket` permission on the bucket, Amazon S3 returns\ - \ an HTTP status code `404 Not Found` error.\n\n * If you don’t have the\ - \ `s3:ListBucket` permission, Amazon S3 returns an HTTP status code `403 Access\ - \ Denied` error.\n\n * **Directory bucket permissions** \\- To grant access\ - \ to this API operation on a directory bucket, we recommend that you use the\ - \ [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nIf the object is encrypted using SSE-KMS, you must also have the `kms:GenerateDataKey`\ - \ and `kms:Decrypt` permissions in IAM identity-based policies and KMS key\ - \ policies for the KMS key.\n\nStorage classes\n\n \n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html).\ - \ Otherwise, this operation returns an `InvalidObjectState` error. For information\ - \ about restoring archived objects, see [Restoring Archived Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html)\ - \ in the _Amazon S3 User Guide_.\n\n**Directory buckets** \\- Directory buckets\ - \ only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in\ - \ Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage\ - \ class) in Dedicated Local Zones. Unsupported storage class values won't\ - \ write a destination object and will respond with the HTTP status code `400\ - \ Bad Request`.\n\nEncryption\n\n \n\nEncryption 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.\n\n**Directory buckets** \\- For directory buckets, there\ - \ are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.\ - \ SSE-C isn't supported. For more information, see [Protecting data with server-side\ - \ encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\nOverriding response header values through\ - \ the request\n\n \n\nThere 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.\n\nYou 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.\n\nThe\ - \ response headers that you can override for the `GetObject` response are\ - \ `Cache-Control`, `Content-Disposition`, `Content-Encoding`, `Content-Language`,\ - \ `Content-Type`, and `Expires`.\n\nTo override values for a set of response\ - \ headers in the `GetObject` response, you can use the following query parameters\ - \ in the request.\n\n * `response-cache-control`\n\n * `response-content-disposition`\n\ - \n * `response-content-encoding`\n\n * `response-content-language`\n\n \ - \ * `response-content-type`\n\n * `response-expires`\n\nWhen 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.\n\nHTTP Host header syntax\n\n \n\n**Directory buckets** \\\ - - The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `GetObject`:\n\n * [ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)\n\ - \n * [GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: If-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatch' - - name: If-Modified-Since - in: header - required: false - schema: - $ref: '#/components/schemas/IfModifiedSince' - - name: If-None-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfNoneMatch' - - name: If-Unmodified-Since - in: header - required: false - schema: - $ref: '#/components/schemas/IfUnmodifiedSince' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: Range - in: header - required: false - schema: - $ref: '#/components/schemas/Range' - - name: response-cache-control - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseCacheControl' - - name: response-content-disposition - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentDisposition' - - name: response-content-encoding - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentEncoding' - - name: response-content-language - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentLanguage' - - name: response-content-type - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseContentType' - - name: response-expires - in: query - required: false - schema: - $ref: '#/components/schemas/ResponseExpires' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: partNumber - in: query - required: false - schema: - $ref: '#/components/schemas/PartNumber' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-checksum-mode - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumMode' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectOutput' - '403': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidObjectState' - description: |- - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). Otherwise, this operation returns an `InvalidObjectState` error. For information about restoring archived objects, see [Restoring Archived Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) in the _Amazon S3 User Guide_. - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: |- - The specified key does not exist. - /{Bucket}/{Key+}?acl: - get: - operationId: GetObjectAcl - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping) 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the _Amazon S3 User Guide_. - - The following operations are related to `GetObjectAcl`: - - * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) - - * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) - - * [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) - - * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectAclOutput' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: |- - The specified key does not exist. - put: - operationId: PutObjectAcl - description: "End of support notice: As of October 1, 2025, Amazon S3 has discontinued\ - \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ - \ use an Email Grantee ACL in a request after October 1, 2025, the request\ - \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ - \ 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), and South America (São\ - \ Paulo).\n\nThis operation is not supported for directory buckets.\n\nUses\ - \ 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?](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions)\ - \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported for\ - \ Amazon S3 on Outposts.\n\nDepending 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nYou can set access\ - \ permissions using one of the following methods:\n\n * 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-ac`l.\ - \ If you use this header, you cannot use other access control-specific headers\ - \ in your request. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).\n\ - \n * 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).\n\ - \nYou specify each grantee as a type=value pair, where the type is one of\ - \ the following:\n\n * `id` – if the value specified is the canonical user\ - \ ID of an Amazon Web Services account\n\n * `uri` – if you are granting\ - \ permissions to a predefined group\n\n * `emailAddress` – if the value\ - \ specified is the email address of an Amazon Web Services account\n\nUsing\ - \ email addresses to specify a grantee is only supported in the following\ - \ Amazon Web Services Regions:\n\n * US East (N. Virginia)\n\n *\ - \ US West (N. California)\n\n * US West (Oregon)\n\n * Asia Pacific\ - \ (Singapore)\n\n * Asia Pacific (Sydney)\n\n * Asia Pacific (Tokyo)\n\ - \n * Europe (Ireland)\n\n * South America (São Paulo)\n\nFor a list\ - \ of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nFor example, the following\ - \ `x-amz-grant-read` header grants list objects permission to the two Amazon\ - \ Web Services accounts identified by their email addresses.\n\n`x-amz-grant-read:\ - \ emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" `\n\nYou\ - \ can use either a canned ACL or specify access permissions explicitly. You\ - \ cannot do both.\n\nGrantee Values\n\n \n\nYou can specify the person\ - \ (grantee) to whom you're assigning access rights (using request elements)\ - \ in the following ways. For examples of how to specify these grantee values\ - \ in JSON format, see the Amazon Web Services CLI example in [ Enabling Amazon\ - \ S3 server access logging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html)\ - \ in the _Amazon S3 User Guide_.\n\n * By the person's ID:\n\n`<>ID<><>GranteesEmail<>\ - \ `\n\nDisplayName is optional and ignored in the request.\n\n * By URI:\n\ - \n`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`\n\n * By\ - \ Email address:\n\n`<>Grantees@email.com<>lt;/Grantee>`\n\nThe grantee is\ - \ resolved to the CanonicalUser and, in a response to a GET Object acl request,\ - \ appears as the CanonicalUser.\n\nUsing email addresses to specify a grantee\ - \ is only supported in the following Amazon Web Services Regions:\n\n *\ - \ US East (N. Virginia)\n\n * US West (N. California)\n\n * US West\ - \ (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific (Sydney)\n\ - \n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n * South America\ - \ (São Paulo)\n\nFor a list of all the Amazon S3 supported Regions and endpoints,\ - \ see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nVersioning\n\n \n\n\ - 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.\n\nThe following operations are\ - \ related to `PutObjectAcl`:\n\n * [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\n\ - \n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-acl - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectCannedACL' - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-grant-full-control - in: header - required: false - schema: - $ref: '#/components/schemas/GrantFullControl' - - name: x-amz-grant-read - in: header - required: false - schema: - $ref: '#/components/schemas/GrantRead' - - name: x-amz-grant-read-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantReadACP' - - name: x-amz-grant-write - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWrite' - - name: x-amz-grant-write-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWriteACP' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/AccessControlPolicy' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectAclOutput' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: |- - The specified key does not exist. - /{Bucket}/{Key+}?attributes: - get: - operationId: GetObjectAttributes - description: "Retrieves all of the metadata from an object without returning\ - \ the object itself. This operation is useful if you're interested only in\ - \ an object's metadata.\n\n`GetObjectAttributes` combines the functionality\ - \ of `HeadObject` and `ListParts`. All of the data returned with both of those\ - \ individual calls can be returned with a single call to `GetObjectAttributes`.\n\ - \n**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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- To use `GetObjectAttributes`, you must have READ\ - \ access to the object.\n\nThe other permissions that you need to use this\ - \ operation depend on whether the bucket is versioned and if a version ID\ - \ is passed in the `GetObjectAttributes` request.\n\n * If you pass a version\ - \ ID in your request, you need both the `s3:GetObjectVersion` and `s3:GetObjectVersionAttributes`\ - \ permissions.\n\n * If you do not pass a version ID in your request, you\ - \ need the `s3:GetObject` and `s3:GetObjectAttributes` permissions. \n\nFor\ - \ more information, see [Specifying Permissions in a Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf the object that you request does not\ - \ exist, the error Amazon S3 returns depends on whether you also have the\ - \ `s3:ListBucket` permission.\n\n * If you have the `s3:ListBucket` permission\ - \ on the bucket, Amazon S3 returns an HTTP status code `404 Not Found` (\"\ - no such key\") error.\n\n * If you don't have the `s3:ListBucket` permission,\ - \ Amazon S3 returns an HTTP status code `403 Forbidden` (\"access denied\"\ - ) error.\n\n * **Directory bucket permissions** \\- To grant access to this\ - \ API operation on a directory bucket, we recommend that you use the [ `CreateSession`\ - \ ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nIf the object is encrypted with SSE-KMS, you must also have the `kms:GenerateDataKey`\ - \ and `kms:Decrypt` permissions in IAM identity-based policies and KMS key\ - \ policies for the KMS key.\n\nEncryption\n\n \n\nEncryption 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.\n\nIf you encrypted\ - \ an object when you stored the object in Amazon S3 by using server-side encryption\ - \ with customer-provided encryption keys (SSE-C), then when you retrieve the\ - \ metadata from the object, you must use the following headers. These headers\ - \ provide the server with the encryption key required to retrieve the object's\ - \ metadata. The headers are:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\ - \n * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ - \nFor more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided\ - \ Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\n**Directory bucket permissions** \\- For\ - \ directory buckets, there are only two supported options for server-side\ - \ encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)\ - \ (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).\ - \ We recommend that the bucket's default encryption uses the desired encryption\ - \ configuration and you don't override the bucket default encryption in your\ - \ `CreateSession` requests or `PUT` object requests. Then, new objects are\ - \ automatically encrypted with the desired encryption settings. For more information,\ - \ see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_. For more information about the encryption\ - \ overriding behaviors in directory buckets, see [Specifying server-side encryption\ - \ with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\n\ - \nVersioning\n\n \n\n**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.\n\nConditional\ - \ request headers\n\n \n\nConsider the following when using request headers:\n\ - \n * 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:\n\n * `If-Match` condition evaluates to `true`.\n\ - \n * `If-Unmodified-Since` condition evaluates to `false`.\n\nFor more\ - \ information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).\n\ - \n * 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`:\n\n * `If-None-Match` condition evaluates to `false`.\n\ - \n * `If-Modified-Since` condition evaluates to `true`.\n\nFor more information\ - \ about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).\n\ - \nHTTP Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host\ - \ header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following actions are related to `GetObjectAttributes`:\n\n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \n * [GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)\n\ - \n * [GetObjectLegalHold](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html)\n\ - \n * [GetObjectLockConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html)\n\ - \n * [GetObjectRetention](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html)\n\ - \n * [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)\n\ - \n * [HeadObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-max-parts - in: header - required: false - schema: - $ref: '#/components/schemas/MaxParts' - - name: x-amz-part-number-marker - in: header - required: false - schema: - $ref: '#/components/schemas/PartNumberMarker' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-object-attributes - in: header - required: true - schema: - $ref: '#/components/schemas/ObjectAttributesList' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectAttributesOutput' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: |- - The specified key does not exist. - /{Bucket}/{Key+}?legal-hold: - get: - operationId: GetObjectLegalHold - description: |- - This operation is not supported for directory buckets. - - Gets an object's current legal hold status. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - This functionality is not supported for Amazon S3 on Outposts. - - The following action is related to `GetObjectLegalHold`: - - * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectLegalHoldOutput' - put: - operationId: PutObjectLegalHold - description: |- - This operation is not supported for directory buckets. - - Applies a legal hold configuration to the specified object. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - This functionality is not supported for Amazon S3 on Outposts. - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/ObjectLockLegalHold' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectLegalHoldOutput' - /{Bucket}?object-lock: - get: - operationId: GetObjectLockConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - The following action is related to `GetObjectLockConfiguration`: - - * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectLockConfigurationOutput' - put: - operationId: PutObjectLockConfiguration - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - * 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-bucket-object-lock-token - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockToken' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/ObjectLockConfiguration' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectLockConfigurationOutput' - /{Bucket}/{Key+}?retention: - get: - operationId: GetObjectRetention - description: |- - This operation is not supported for directory buckets. - - Retrieves an object's retention settings. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - This functionality is not supported for Amazon S3 on Outposts. - - The following action is related to `GetObjectRetention`: - - * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectRetentionOutput' - put: - operationId: PutObjectRetention - description: |- - This operation is not supported for directory buckets. - - Places an Object Retention configuration on an object. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). 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. - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-bypass-governance-retention - in: header - required: false - schema: - $ref: '#/components/schemas/BypassGovernanceRetention' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/ObjectLockRetention' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectRetentionOutput' - /{Bucket}/{Key+}?torrent: - get: - operationId: GetObjectTorrent - description: |- - This operation is not supported for 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`: - - * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectTorrentOutput' - /{Bucket}?analytics&x-id=ListBucketAnalyticsConfigurations: - get: - operationId: ListBucketAnalyticsConfigurations - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). - - The following operations are related to `ListBucketAnalyticsConfigurations`: - - * [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) - - * [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) - - * [PutBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/Token' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketAnalyticsConfigurationsOutput' - /{Bucket}?intelligent-tiering&x-id=ListBucketIntelligentTieringConfigurations: - get: - operationId: ListBucketIntelligentTieringConfigurations - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). - - Operations related to `ListBucketIntelligentTieringConfigurations` include: - - * [DeleteBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) - - * [PutBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) - - * [GetBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/Token' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketIntelligentTieringConfigurationsOutput' - /{Bucket}?inventory&x-id=ListBucketInventoryConfigurations: - get: - operationId: ListBucketInventoryConfigurations - description: |- - This operation is not supported for directory buckets. - - Returns a list of S3 Inventory configurations for the bucket. You can have up to 1,000 inventory 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) - - The following operations are related to `ListBucketInventoryConfigurations`: - - * [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) - - * [DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) - - * [PutBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/Token' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketInventoryConfigurationsOutput' - /{Bucket}?metrics&x-id=ListBucketMetricsConfigurations: - get: - operationId: ListBucketMetricsConfigurations - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). - - For more information about metrics configurations and CloudWatch request metrics, see [Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). - - The following operations are related to `ListBucketMetricsConfigurations`: - - * [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) - - * [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) - - * [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/Token' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketMetricsConfigurationsOutput' - /?x-id=ListBuckets&__region={region}: - servers: - - url: https://s3.amazonaws.com - get: - operationId: ListBuckets - description: |- - This operation is not supported for directory buckets. - - Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the `s3:ListAllMyBuckets` policy action. - - For information about Amazon S3 buckets, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html). - - We strongly recommend using only paginated `ListBuckets` requests. Unpaginated `ListBuckets` requests are only supported for Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved general purpose bucket quota above 10,000, you must send paginated `ListBuckets` requests to list your account’s buckets. All unpaginated `ListBuckets` requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota greater than 10,000. - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: region - in: query - required: true - schema: - type: string - - name: x-amz-content-sha256 - in: header - required: false - schema: - type: string - default: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - - name: max-buckets - in: query - required: false - schema: - $ref: '#/components/schemas/MaxBuckets' - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/Token' - - name: prefix - in: query - required: false - schema: - $ref: '#/components/schemas/Prefix' - - name: bucket-region - in: query - required: false - schema: - $ref: '#/components/schemas/BucketRegion' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketsOutput' - /?x-id=ListDirectoryBuckets: - get: - operationId: ListDirectoryBuckets - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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\ - \ about endpoints in Availability Zones, see [Regional and Zonal endpoints\ - \ for directory buckets in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is `s3express-control._region_.amazonaws.com`.\n\ - \nThe `BucketRegion` response element is not part of the `ListDirectoryBuckets`\ - \ Response Syntax.\n\nYou must URL encode any signed header values that contain\ - \ spaces. For example, if your header value is `my file.txt`, containing two\ - \ spaces after `my`, you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/DirectoryBucketToken' - - name: max-directory-buckets - in: query - required: false - schema: - $ref: '#/components/schemas/MaxDirectoryBuckets' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListDirectoryBucketsOutput' - /{Bucket}?uploads: - get: - operationId: ListMultipartUploads - description: "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.\n\n**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. To delete these in-progress\ - \ multipart uploads, use the `ListMultipartUploads` operation to list the\ - \ in-progress multipart uploads in the bucket and use the `AbortMultipartUpload`\ - \ operation to abort all the in-progress multipart uploads.\n\nThe `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.\n\n**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.\n\ - \nFor more information about multipart uploads, see [Uploading Objects Using\ - \ Multipart Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- For information about permissions required to use\ - \ the multipart upload API, see [Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nSorting of multipart uploads in response\n\n \n\n * **General purpose\ - \ bucket** \\- In the `ListMultipartUploads` response, the multipart uploads\ - \ are sorted based on two criteria:\n\n * Key-based sorting - Multipart\ - \ uploads are initially sorted in ascending order based on their object keys.\n\ - \n * 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.\n\n * **Directory bucket** \\\ - - In the `ListMultipartUploads` response, the multipart uploads aren't sorted\ - \ lexicographically based on the object keys. \n\nHTTP Host header syntax\n\ - \n \n\n**Directory buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `ListMultipartUploads`:\n\n * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: delimiter - in: query - required: false - schema: - $ref: '#/components/schemas/Delimiter' - - name: encoding-type - in: query - required: false - schema: - $ref: '#/components/schemas/EncodingType' - - name: key-marker - in: query - required: false - schema: - $ref: '#/components/schemas/KeyMarker' - - name: max-uploads - in: query - required: false - schema: - $ref: '#/components/schemas/MaxUploads' - - name: prefix - in: query - required: false - schema: - $ref: '#/components/schemas/Prefix' - - name: upload-id-marker - in: query - required: false - schema: - $ref: '#/components/schemas/UploadIdMarker' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListMultipartUploadsOutput' - /{Bucket}?versions: - get: - operationId: ListObjectVersions - description: |- - This operation is not supported for 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`: - - * [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) - - * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) - - * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) - - * [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: delimiter - in: query - required: false - schema: - $ref: '#/components/schemas/Delimiter' - - name: encoding-type - in: query - required: false - schema: - $ref: '#/components/schemas/EncodingType' - - name: key-marker - in: query - required: false - schema: - $ref: '#/components/schemas/KeyMarker' - - name: max-keys - in: query - required: false - schema: - $ref: '#/components/schemas/MaxKeys' - - name: prefix - in: query - required: false - schema: - $ref: '#/components/schemas/Prefix' - - name: version-id-marker - in: query - required: false - schema: - $ref: '#/components/schemas/VersionIdMarker' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-optional-object-attributes - in: header - required: false - schema: - $ref: '#/components/schemas/OptionalObjectAttributesList' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectVersionsOutput' - /{Bucket}?list-type=2: - get: - operationId: ListObjectsV2 - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html)\ - \ in the _Amazon S3 User Guide_. To get a list of your buckets, see [ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html).\n\ - \n * **General purpose bucket** \\- For general purpose buckets, `ListObjectsV2`\ - \ doesn't return prefixes that are related only to in-progress multipart uploads.\n\ - \n * **Directory buckets** \\- For directory buckets, `ListObjectsV2` response\ - \ includes the prefixes that are related only to in-progress multipart uploads.\ - \ \n\n * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)\ - \ and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nSorting order of returned objects\n\n \n\n * **General purpose bucket**\ - \ \\- For general purpose buckets, `ListObjectsV2` returns objects in lexicographical\ - \ order based on their key names.\n\n * **Directory bucket** \\- For directory\ - \ buckets, `ListObjectsV2` does not return objects in lexicographical order.\n\ - \nHTTP Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host\ - \ header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThis 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html).\n\ - \nThe following operations are related to `ListObjectsV2`:\n\n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \n * [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: delimiter - in: query - required: false - schema: - $ref: '#/components/schemas/Delimiter' - - name: encoding-type - in: query - required: false - schema: - $ref: '#/components/schemas/EncodingType' - - name: max-keys - in: query - required: false - schema: - $ref: '#/components/schemas/MaxKeys' - - name: prefix - in: query - required: false - schema: - $ref: '#/components/schemas/Prefix' - - name: continuation-token - in: query - required: false - schema: - $ref: '#/components/schemas/Token' - - name: fetch-owner - in: query - required: false - schema: - $ref: '#/components/schemas/FetchOwner' - - name: start-after - in: query - required: false - schema: - $ref: '#/components/schemas/StartAfter' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-optional-object-attributes - in: header - required: false - schema: - $ref: '#/components/schemas/OptionalObjectAttributesList' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectsV2Output' - '404': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: |- - The specified bucket does not exist. - /{Bucket}/{Key+}?x-id=ListParts: - get: - operationId: ListParts - description: "Lists the parts that have been uploaded for a specific multipart\ - \ upload.\n\nTo 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html).\n\ - \nThe `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.\n\n\ - For more information on multipart uploads, see [Uploading Objects Using Multipart\ - \ Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- For information about permissions required to use\ - \ the multipart upload API, see [Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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.\n\n * **Directory bucket permissions** \\- To grant access\ - \ to this API operation on a directory bucket, we recommend that you use the\ - \ [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nHTTP Host header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host\ - \ header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `ListParts`:\n\n * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \n * [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)\n\ - \n * [ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: max-parts - in: query - required: false - schema: - $ref: '#/components/schemas/MaxParts' - - name: part-number-marker - in: query - required: false - schema: - $ref: '#/components/schemas/PartNumberMarker' - - name: uploadId - in: query - required: true - schema: - $ref: '#/components/schemas/MultipartUploadId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPartsOutput' - /{Bucket}/{Key+}?x-id=PutObject: - put: - operationId: PutObject - description: "End of support notice: As of October 1, 2025, Amazon S3 has discontinued\ - \ support for Email Grantee Access Control Lists (ACLs). If you attempt to\ - \ use an Email Grantee ACL in a request after October 1, 2025, the request\ - \ will receive an `HTTP 405` (Method Not Allowed) error.\n\nThis change affects\ - \ 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), and South America (São\ - \ Paulo).\n\nAdds an object to a bucket.\n\n * 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.\n\n * 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.\n\n * **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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nAmazon 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:\n\n * **S3 Object Lock** \\- To\ - \ prevent objects from being deleted or overwritten, you can use [Amazon S3\ - \ Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html)\ - \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported for\ - \ directory buckets.\n\n * **If-None-Match** \\- Uploads the object only\ - \ if the object key name does not already exist in the specified bucket. Otherwise,\ - \ Amazon S3 returns a `412 Precondition Failed` error. If a conflicting operation\ - \ occurs during the upload, S3 returns a `409 ConditionalRequestConflict`\ - \ response. On a 409 failure, retry the upload.\n\nExpects the * character\ - \ (asterisk).\n\nFor more information, see [Add preconditions to S3 operations\ - \ with conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html)\ - \ in the _Amazon S3 User Guide_ or [RFC 7232](https://datatracker.ietf.org/doc/rfc7232/).\n\ - \nThis functionality is not supported for S3 on Outposts.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html)\ - \ in the _Amazon S3 User Guide_. For information about returning the versioning\ - \ state of a bucket, see [GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html).\ - \ \n\nThis functionality is not supported for directory buckets.\n\nPermissions\n\ - \n \n\n * **General purpose bucket permissions** \\- The following permissions\ - \ are required in your policies when your `PutObject` request includes specific\ - \ headers.\n\n * **`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.\n\n * **`s3:PutObjectAcl` ** \\- To successfully\ - \ change the objects ACL of your `PutObject` request, you must have the `s3:PutObjectAcl`.\n\ - \n * **`s3:PutObjectTagging` ** \\- To successfully set the tag-set with\ - \ your `PutObject` request, you must have the `s3:PutObjectTagging`.\n\n \ - \ * **Directory bucket permissions** \\- To grant access to this API operation\ - \ on a directory bucket, we recommend that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nIf the object is encrypted with SSE-KMS, you must also have the `kms:GenerateDataKey`\ - \ and `kms:Decrypt` permissions in IAM identity-based policies and KMS key\ - \ policies for the KMS key.\n\nData integrity with Content-MD5\n\n \n\n\ - \ * **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.\n\n\ - \ * **Directory bucket** \\- This functionality is not supported for directory\ - \ buckets.\n\nHTTP Host header syntax\n\n \n\n**Directory buckets** \\\ - - The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nFor more information about related Amazon S3 APIs, see the following:\n\n\ - \ * [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\n\ - \n * [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: x-amz-acl - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectCannedACL' - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Cache-Control - in: header - required: false - schema: - $ref: '#/components/schemas/CacheControl' - - name: Content-Disposition - in: header - required: false - schema: - $ref: '#/components/schemas/ContentDisposition' - - name: Content-Encoding - in: header - required: false - schema: - $ref: '#/components/schemas/ContentEncoding' - - name: Content-Language - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLanguage' - - name: Content-Length - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLength' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: Content-Type - in: header - required: false - schema: - $ref: '#/components/schemas/ContentType' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-checksum-crc32 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32' - - name: x-amz-checksum-crc32c - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32C' - - name: x-amz-checksum-crc64nvme - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC64NVME' - - name: x-amz-checksum-sha1 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA1' - - name: x-amz-checksum-sha256 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA256' - - name: Expires - in: header - required: false - schema: - $ref: '#/components/schemas/Expires' - - name: If-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatch' - - name: If-None-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfNoneMatch' - - name: x-amz-grant-full-control - in: header - required: false - schema: - $ref: '#/components/schemas/GrantFullControl' - - name: x-amz-grant-read - in: header - required: false - schema: - $ref: '#/components/schemas/GrantRead' - - name: x-amz-grant-read-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantReadACP' - - name: x-amz-grant-write-acp - in: header - required: false - schema: - $ref: '#/components/schemas/GrantWriteACP' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-write-offset-bytes - in: header - required: false - schema: - $ref: '#/components/schemas/WriteOffsetBytes' - - name: x-amz-server-side-encryption - in: header - required: false - schema: - $ref: '#/components/schemas/ServerSideEncryption' - - name: x-amz-storage-class - in: header - required: false - schema: - $ref: '#/components/schemas/StorageClass' - - name: x-amz-website-redirect-location - in: header - required: false - schema: - $ref: '#/components/schemas/WebsiteRedirectLocation' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-server-side-encryption-aws-kms-key-id - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSKeyId' - - name: x-amz-server-side-encryption-context - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - - name: x-amz-server-side-encryption-bucket-key-enabled - in: header - required: false - schema: - $ref: '#/components/schemas/BucketKeyEnabled' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-tagging - in: header - required: false - schema: - $ref: '#/components/schemas/TaggingHeader' - - name: x-amz-object-lock-mode - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockMode' - - name: x-amz-object-lock-retain-until-date - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - - name: x-amz-object-lock-legal-hold - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/StreamingBlob' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectOutput' - '400': - content: - text/xml: - schema: - $ref: '#/components/schemas/TooManyParts' - description: |- - You have attempted to add more parts than the maximum of 10000 that are allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object. - /{Bucket}/{Key+}?renameObject: - put: - operationId: RenameObject - description: "Renames an existing object in a directory bucket that uses the\ - \ S3 Express One Zone storage class. You can use `RenameObject` by specifying\ - \ an existing object’s name as the source and the new name of the object as\ - \ the destination within the same directory bucket.\n\n`RenameObject` is only\ - \ supported for objects stored in the S3 Express One Zone storage class.\n\ - \nTo prevent overwriting an object, you can use the `If-None-Match` conditional\ - \ header.\n\n * **If-None-Match** \\- Renames the object only if an object\ - \ with the specified name does not already exist in the directory bucket.\ - \ If you don't want to overwrite an existing object, you can add the `If-None-Match`\ - \ conditional header with the value `‘*’` in the `RenameObject` request. Amazon\ - \ S3 then returns a `412 Precondition Failed` error if the object with the\ - \ specified name already exists. For more information, see [RFC 7232](https://datatracker.ietf.org/doc/rfc7232/).\n\ - \nPermissions\n\n \n\nTo grant access to the `RenameObject` operation on\ - \ a directory bucket, we recommend that you use the `CreateSession` 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 directory 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. The Amazon Web Services CLI and SDKs will create and manage your\ - \ session including refreshing the session token automatically to avoid service\ - \ interruptions when a session expires. In your bucket policy, you can specify\ - \ the `s3express:SessionMode` condition key to control who can create a `ReadWrite`\ - \ or `ReadOnly` session. A `ReadWrite` session is required for executing all\ - \ the Zonal endpoint API operations, including `RenameObject`. For more information\ - \ about authorization, see [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\ - \ To learn more about Zonal endpoint API operations, see [Authorizing Zonal\ - \ endpoint API operations with CreateSession](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-create-session.html)\ - \ in the _Amazon S3 User Guide_.\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-rename-source - in: header - required: true - schema: - $ref: '#/components/schemas/RenameSource' - - name: If-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfMatch' - - name: If-None-Match - in: header - required: false - schema: - $ref: '#/components/schemas/IfNoneMatch' - - name: If-Modified-Since - in: header - required: false - schema: - $ref: '#/components/schemas/IfModifiedSince' - - name: If-Unmodified-Since - in: header - required: false - schema: - $ref: '#/components/schemas/IfUnmodifiedSince' - - name: x-amz-rename-source-if-match - in: header - required: false - schema: - $ref: '#/components/schemas/RenameSourceIfMatch' - - name: x-amz-rename-source-if-none-match - in: header - required: false - schema: - $ref: '#/components/schemas/RenameSourceIfNoneMatch' - - name: x-amz-rename-source-if-modified-since - in: header - required: false - schema: - $ref: '#/components/schemas/RenameSourceIfModifiedSince' - - name: x-amz-rename-source-if-unmodified-since - in: header - required: false - schema: - $ref: '#/components/schemas/RenameSourceIfUnmodifiedSince' - - name: x-amz-client-token - in: header - required: false - schema: - $ref: '#/components/schemas/ClientToken' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RenameObjectOutput' - '400': - content: - text/xml: - schema: - $ref: '#/components/schemas/IdempotencyParameterMismatch' - description: |- - Parameters on this idempotent request are inconsistent with parameters used in previous request(s). - - For a list of error codes and more information on Amazon S3 errors, see [Error codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions. - /{Bucket}/{Key+}?restore: - post: - operationId: RestoreObject - description: "This operation is not supported for directory buckets.\n\nRestores\ - \ an archived copy of an object back into Amazon S3\n\nThis functionality\ - \ is not supported for Amazon S3 on Outposts.\n\nThis action performs the\ - \ following types of requests:\n\n * `restore an archive` \\- Restore an\ - \ archived object\n\nFor more information about the `S3` structure in the\ - \ request body, see the following:\n\n * [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)\n\ - \n * [Managing Access with ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html)\ - \ in the _Amazon S3 User Guide_\n\n * [Protecting Data Using Server-Side\ - \ Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_\n\nPermissions\n\n \n\nTo 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)\ - \ and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)\ - \ in the _Amazon S3 User Guide_.\n\nRestoring objects\n\n \n\nObjects that\ - \ you archive to the S3 Glacier 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 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.\n\nTo 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.\n\nWhen restoring an archived object, you can specify one of the\ - \ following data access tier options in the `Tier` element of the request\ - \ body:\n\n * `Expedited` \\- Expedited retrievals allow you to quickly access\ - \ your data stored in the S3 Glacier 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.\n\n * `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\ - \ 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.\n\n * `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\ - \ 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. \n\nFor more information about archive retrieval options and\ - \ provisioned capacity for `Expedited` data access, see [Restoring Archived\ - \ Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html)\ - \ in the _Amazon S3 User Guide_.\n\nTo 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\ - \ in the _Amazon S3 User Guide_.\n\nAfter 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.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)\ - \ and [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)\ - \ in _Amazon S3 User Guide_.\n\nResponses\n\n \n\nA successful action returns\ - \ either the `200 OK` or `202 Accepted` status code.\n\n * If the object\ - \ is not previously restored, then Amazon S3 returns `202 Accepted` in the\ - \ response. \n\n * If the object is previously restored, Amazon S3 returns\ - \ `200 OK` in the response. \n\n * Special errors:\n\n * _Code: RestoreAlreadyInProgress_\n\ - \n * _Cause: Object restore is already in progress._\n\n * _HTTP Status\ - \ Code: 409 Conflict_\n\n * _SOAP Fault Code Prefix: Client_\n\n * \ - \ * _Code: GlacierExpeditedRetrievalNotAvailable_\n\n * _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.)_\n\ - \n * _HTTP Status Code: 503_\n\n * _SOAP Fault Code Prefix: N/A_\n\n\ - The following operations are related to `RestoreObject`:\n\n * [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)\n\ - \n * [GetBucketNotificationConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: versionId - in: query - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/RestoreRequest' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreObjectOutput' - '403': - content: - text/xml: - schema: - $ref: '#/components/schemas/ObjectAlreadyInActiveTierError' - description: |- - This action is not allowed against this storage tier. - /{Bucket}/{Key+}?select&select-type=2: - post: - operationId: SelectObjectContent - description: "This operation is not supported for directory buckets.\n\nThis\ - \ 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.\n\n\ - This functionality is not supported for Amazon S3 on Outposts.\n\nFor more\ - \ information about Amazon S3 Select, see [Selecting Content from Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html)\ - \ and [SELECT Command](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)\ - \ in the _Amazon S3 User Guide_.\n\nObject Data Formats\n\n \n\nYou can\ - \ use Amazon S3 Select to query objects that have the following format properties:\n\ - \n * _CSV, JSON, and Parquet_ \\- Objects must be in CSV, JSON, or Parquet\ - \ format.\n\n * _UTF-8_ \\- UTF-8 is the only encoding type Amazon S3 Select\ - \ supports.\n\n * _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.\n\n * _Server-side\ - \ encryption_ \\- Amazon S3 Select supports querying objects that are protected\ - \ with server-side encryption.\n\nFor 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html).\ - \ For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided\ - \ Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\nFor 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\nWorking with the Response Body\n\n \ - \ \n\nGiven 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](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html).\n\ - \nGetObject Support\n\n \n\nThe `SelectObjectContent` action does not support\ - \ the following `GetObject` functionality. For more information, see [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html).\n\ - \n * `Range`: Although you can specify a scan range for an Amazon S3 Select\ - \ request (see [SelectObjectContentRequest - ScanRange](https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange)\ - \ in the request parameters), you cannot specify the range of bytes of an\ - \ object to return. \n\n * 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html)\ - \ in the _Amazon S3 User Guide_.\n\nSpecial Errors\n\n \n\nFor a list of\ - \ special errors for this operation, see [List of SELECT Object Content Error\ - \ Codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList)\n\ - \nThe following operations are related to `SelectObjectContent`:\n\n * [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)\n\ - \n * [GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)\n\ - \n * [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - type: object - properties: - Expression: - $ref: '#/components/schemas/Expression' - ExpressionType: - $ref: '#/components/schemas/ExpressionType' - RequestProgress: - $ref: '#/components/schemas/RequestProgress' - InputSerialization: - $ref: '#/components/schemas/InputSerialization' - OutputSerialization: - $ref: '#/components/schemas/OutputSerialization' - ScanRange: - $ref: '#/components/schemas/ScanRange' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SelectObjectContentOutput' - /{Bucket}?metadataInventoryTable: - put: - operationId: UpdateBucketMetadataInventoryTableConfiguration - description: "Enables or disables a live inventory table for an S3 Metadata\ - \ configuration on a general purpose bucket. For more information, see [Accelerating\ - \ data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nTo use this operation,\ - \ you must have the following permissions. For more information, see [Setting\ - \ up permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf you want to encrypt your inventory\ - \ table with server-side encryption with Key Management Service (KMS) keys\ - \ (SSE-KMS), you need additional permissions in your KMS key policy. For more\ - \ information, see [ Setting up permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\n * `s3:UpdateBucketMetadataInventoryTableConfiguration`\n\ - \n * `s3tables:CreateTableBucket`\n\n * `s3tables:CreateNamespace`\n\n \ - \ * `s3tables:GetTable`\n\n * `s3tables:CreateTable`\n\n * `s3tables:PutTablePolicy`\n\ - \n * `s3tables:PutTableEncryption`\n\n * `kms:DescribeKey`\n\nThe following\ - \ operations are related to `UpdateBucketMetadataInventoryTableConfiguration`:\n\ - \n * [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\n\ - \n * [DeleteBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html)\n\ - \n * [GetBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataConfiguration.html)\n\ - \n * [UpdateBucketMetadataJournalTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/InventoryTableConfigurationUpdates' - responses: - '200': - description: Success - /{Bucket}?metadataJournalTable: - put: - operationId: UpdateBucketMetadataJournalTableConfiguration - description: "Enables or disables journal table record expiration for an S3\ - \ Metadata configuration on a general purpose bucket. For more information,\ - \ see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\nTo use this operation,\ - \ you must have the `s3:UpdateBucketMetadataJournalTableConfiguration` permission.\ - \ For more information, see [Setting up permissions for configuring metadata\ - \ tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)\ - \ in the _Amazon S3 User Guide_.\n\nThe following operations are related to\ - \ `UpdateBucketMetadataJournalTableConfiguration`:\n\n * [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html)\n\ - \n * [DeleteBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html)\n\ - \n * [GetBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataConfiguration.html)\n\ - \n * [UpdateBucketMetadataInventoryTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataInventoryTableConfiguration.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/JournalTableConfigurationUpdates' - responses: - '200': - description: Success - /{Bucket}/{Key+}?x-id=UploadPart: - put: - operationId: UploadPart - description: "Uploads a part in a multipart upload.\n\nIn 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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)\ - \ operation.\n\nYou must initiate a multipart upload (see [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html))\ - \ 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.\n\nPart 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.\n\nFor information about maximum and minimum\ - \ part sizes and other multipart upload specifications, see [Multipart upload\ - \ limits](https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html)\ - \ in the _Amazon S3 User Guide_.\n\nAfter 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.\n\nFor more\ - \ information on multipart uploads, go to [Multipart Upload Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nPermissions\n\n \n\n * **General purpose\ - \ bucket permissions** \\- To perform a multipart upload with encryption using\ - \ an Key Management Service key, the requester must have permission to the\ - \ `kms:Decrypt` and `kms:GenerateDataKey` actions on the key. The requester\ - \ must also have permissions for the `kms:GenerateDataKey` action for the\ - \ `CreateMultipartUpload` API. Then, the requester needs permissions for the\ - \ `kms:Decrypt` action on the `UploadPart` and `UploadPartCopy` APIs.\n\n\ - 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 about KMS permissions, see [Protecting data using server-side\ - \ encryption with KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)\ - \ in the _Amazon S3 User Guide_. For information about the permissions required\ - \ to use the multipart upload API, see [Multipart upload and permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)\ - \ and [Multipart upload API and permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory bucket permissions** \\\ - - To grant access to this API operation on a directory bucket, we recommend\ - \ that you use the [ `CreateSession` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html)\ - \ 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` ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).\n\ - \nIf the object is encrypted with SSE-KMS, you must also have the `kms:GenerateDataKey`\ - \ and `kms:Decrypt` permissions in IAM identity-based policies and KMS key\ - \ policies for the KMS key.\n\nData integrity\n\n \n\n**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)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html).\n\ - \n**Directory buckets** \\- MD5 is not supported by directory buckets. You\ - \ can use checksum algorithms to check object integrity.\n\nEncryption\n\n\ - \ \n\n * **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).\n\nServer-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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html).\n\ - \nIf you have server-side encryption with customer-provided keys (SSE-C) blocked\ - \ for your general purpose bucket, you will get an HTTP 403 Access Denied\ - \ error when you specify the SSE-C request headers while writing new data\ - \ to your bucket. For more information, see [Blocking or unblocking SSE-C\ - \ for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).\n\ - \nIf 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.\n\n * x-amz-server-side-encryption-customer-algorithm\n\ - \n * x-amz-server-side-encryption-customer-key\n\n * x-amz-server-side-encryption-customer-key-MD5\n\ - \nFor more information, see [Using Server-Side Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- For directory\ - \ buckets, there are only two supported options for server-side encryption:\ - \ server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and\ - \ server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).\n\nSpecial errors\n\ - \n \n\n * Error Code: `NoSuchUpload`\n\n * Description: The specified\ - \ multipart upload does not exist. The upload ID might be invalid, or the\ - \ multipart upload might have been aborted or completed.\n\n * HTTP Status\ - \ Code: 404 Not Found \n\n * SOAP Fault Code Prefix: Client\n\nHTTP Host\ - \ header syntax\n\n \n\n**Directory buckets** \\- The HTTP Host header\ - \ syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `UploadPart`:\n\n * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: Content-Length - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLength' - - name: Content-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/ContentMD5' - - name: x-amz-sdk-checksum-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumAlgorithm' - - name: x-amz-checksum-crc32 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32' - - name: x-amz-checksum-crc32c - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32C' - - name: x-amz-checksum-crc64nvme - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC64NVME' - - name: x-amz-checksum-sha1 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA1' - - name: x-amz-checksum-sha256 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA256' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: partNumber - in: query - required: true - schema: - $ref: '#/components/schemas/PartNumber' - - name: uploadId - in: query - required: true - schema: - $ref: '#/components/schemas/MultipartUploadId' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/StreamingBlob' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadPartOutput' - /{Bucket}/{Key+}?x-id=UploadPartCopy: - put: - operationId: UploadPartCopy - description: "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.\n\nFor information about maximum and minimum part sizes\ - \ and other multipart upload specifications, see [Multipart upload limits](https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html)\ - \ in the _Amazon S3 User Guide_.\n\nInstead of copying data from an existing\ - \ object as part data, you might use the [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\ - \ action to upload new data as a part of an object in your request.\n\nYou\ - \ 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.\n\nFor conceptual information\ - \ about multipart uploads, see [Uploading Objects Using Multipart Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)\ - \ in the _Amazon S3 User Guide_. For information about copying objects using\ - \ a single atomic action vs. a multipart upload, see [Operations on Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html)\ - \ in the _Amazon S3 User Guide_.\n\n**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://_amzn-s3-demo-bucket_.s3express-_zone-id_._region-code_.amazonaws.com/_key-name_\ - \ `. Path-style requests are not supported. For more information about endpoints\ - \ in Availability Zones, see [Regional and Zonal endpoints for directory buckets\ - \ in Availability Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)\ - \ in the _Amazon S3 User Guide_. For more information about endpoints in Local\ - \ Zones, see [Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)\ - \ in the _Amazon S3 User Guide_.\n\nAuthentication and authorization\n\n \ - \ \n\nAll `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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).\n\ - \n**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.\n\nAmazon Web Services CLI or SDKs handles authentication and\ - \ authorization on your behalf.\n\nPermissions\n\n \n\nYou must have `READ`\ - \ access to the source object and `WRITE` access to the destination bucket.\n\ - \n * **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.\n\n * 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. \n\n * If the destination\ - \ bucket is a general purpose bucket, you must have the **`s3:PutObject` **\ - \ permission to write the object copy to the destination bucket. \n\n *\ - \ To perform a multipart upload with encryption using an Key Management Service\ - \ key, the requester must have permission to the `kms:Decrypt` and `kms:GenerateDataKey`\ - \ actions on the key. The requester must also have permissions for the `kms:GenerateDataKey`\ - \ action for the `CreateMultipartUpload` API. Then, the requester needs permissions\ - \ for the `kms:Decrypt` action on the `UploadPart` and `UploadPartCopy` APIs.\ - \ 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 about KMS permissions, see [Protecting data using server-side\ - \ encryption with KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)\ - \ in the _Amazon S3 User Guide_. For information about the permissions required\ - \ to use the multipart upload API, see [Multipart upload and permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)\ - \ and [Multipart upload API and permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)\ - \ in the _Amazon S3 User Guide_.\n\n * **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.\n\n * 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.\n\n * 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. \n\nIf the object is encrypted with SSE-KMS, you must\ - \ also have the `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM\ - \ identity-based policies and KMS key policies for the KMS key.\n\nFor example\ - \ policies, see [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)\ - \ and [Amazon Web Services Identity and Access Management (IAM) identity-based\ - \ policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)\ - \ in the _Amazon S3 User Guide_.\n\nEncryption\n\n \n\n * **General purpose\ - \ buckets** \\- For information about using server-side encryption with customer-provided\ - \ encryption keys with the `UploadPartCopy` operation, see [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html).\ - \ \n\nIf you have server-side encryption with customer-provided keys (SSE-C)\ - \ blocked for your general purpose bucket, you will get an HTTP 403 Access\ - \ Denied error when you specify the SSE-C request headers while writing new\ - \ data to your bucket. For more information, see [Blocking or unblocking SSE-C\ - \ for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).\n\ - \n * **Directory buckets** \\- For directory buckets, there are only two\ - \ supported options for server-side encryption: server-side encryption with\ - \ Amazon S3 managed keys (SSE-S3) (`AES256`) and server-side encryption with\ - \ KMS keys (SSE-KMS) (`aws:kms`). For more information, see [Protecting data\ - \ with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\nFor directory buckets, when you perform\ - \ a `CreateMultipartUpload` operation and an `UploadPartCopy` operation, the\ - \ request headers you provide in the `CreateMultipartUpload` request must\ - \ match the default encryption configuration of the destination bucket.\n\n\ - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from\ - \ general purpose buckets to directory buckets, from directory buckets to\ - \ general purpose buckets, or between directory buckets, through [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html).\ - \ In this case, Amazon S3 makes a call to KMS every time a copy request is\ - \ made for a KMS-encrypted object.\n\nSpecial errors\n\n \n\n * Error\ - \ Code: `NoSuchUpload`\n\n * Description: The specified multipart upload\ - \ does not exist. The upload ID might be invalid, or the multipart upload\ - \ might have been aborted or completed.\n\n * HTTP Status Code: 404 Not\ - \ Found\n\n * Error Code: `InvalidRequest`\n\n * Description: The specified\ - \ copy source is not supported as a byte-range copy source.\n\n * HTTP\ - \ Status Code: 400 Bad Request\n\nHTTP Host header syntax\n\n \n\n**Directory\ - \ buckets** \\- The HTTP Host header syntax is ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`.\n\ - \nThe following operations are related to `UploadPartCopy`:\n\n * [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)\n\ - \n * [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)\n\ - \n * [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)\n\ - \n * [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)\n\ - \n * [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)\n\ - \n * [ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)\n\ - \nYou must URL encode any signed header values that contain spaces. For example,\ - \ if your header value is `my file.txt`, containing two spaces after `my`,\ - \ you must URL encode this value to `my%20%20file.txt`." - parameters: - - name: Bucket - in: path - required: true - schema: - $ref: '#/components/schemas/BucketName' - - name: x-amz-copy-source - in: header - required: true - schema: - $ref: '#/components/schemas/CopySource' - - name: x-amz-copy-source-if-match - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfMatch' - - name: x-amz-copy-source-if-modified-since - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfModifiedSince' - - name: x-amz-copy-source-if-none-match - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfNoneMatch' - - name: x-amz-copy-source-if-unmodified-since - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceIfUnmodifiedSince' - - name: x-amz-copy-source-range - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceRange' - - name: Key - in: path - required: true - schema: - $ref: '#/components/schemas/ObjectKey' - - name: partNumber - in: query - required: true - schema: - $ref: '#/components/schemas/PartNumber' - - name: uploadId - in: query - required: true - schema: - $ref: '#/components/schemas/MultipartUploadId' - - name: x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKey' - - name: x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-copy-source-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceSSECustomerAlgorithm' - - name: x-amz-copy-source-server-side-encryption-customer-key - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceSSECustomerKey' - - name: x-amz-copy-source-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/CopySourceSSECustomerKeyMD5' - - name: x-amz-request-payer - in: header - required: false - schema: - $ref: '#/components/schemas/RequestPayer' - - name: x-amz-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - - name: x-amz-source-expected-bucket-owner - in: header - required: false - schema: - $ref: '#/components/schemas/AccountId' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadPartCopyOutput' - /WriteGetObjectResponse: - post: - operationId: WriteGetObjectResponse - description: |- - This operation is not supported for 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) in the _Amazon S3 User Guide_. - - This operation supports metadata that can be returned by [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html), 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html) in the _Amazon S3 User Guide_. - - You must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`. - parameters: - - name: x-amz-request-route - in: header - required: true - schema: - $ref: '#/components/schemas/RequestRoute' - - name: x-amz-request-token - in: header - required: true - schema: - $ref: '#/components/schemas/RequestToken' - - name: x-amz-fwd-status - in: header - required: false - schema: - $ref: '#/components/schemas/GetObjectResponseStatusCode' - - name: x-amz-fwd-error-code - in: header - required: false - schema: - $ref: '#/components/schemas/ErrorCode' - - name: x-amz-fwd-error-message - in: header - required: false - schema: - $ref: '#/components/schemas/ErrorMessage' - - name: x-amz-fwd-header-accept-ranges - in: header - required: false - schema: - $ref: '#/components/schemas/AcceptRanges' - - name: x-amz-fwd-header-Cache-Control - in: header - required: false - schema: - $ref: '#/components/schemas/CacheControl' - - name: x-amz-fwd-header-Content-Disposition - in: header - required: false - schema: - $ref: '#/components/schemas/ContentDisposition' - - name: x-amz-fwd-header-Content-Encoding - in: header - required: false - schema: - $ref: '#/components/schemas/ContentEncoding' - - name: x-amz-fwd-header-Content-Language - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLanguage' - - name: Content-Length - in: header - required: false - schema: - $ref: '#/components/schemas/ContentLength' - - name: x-amz-fwd-header-Content-Range - in: header - required: false - schema: - $ref: '#/components/schemas/ContentRange' - - name: x-amz-fwd-header-Content-Type - in: header - required: false - schema: - $ref: '#/components/schemas/ContentType' - - name: x-amz-fwd-header-x-amz-checksum-crc32 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32' - - name: x-amz-fwd-header-x-amz-checksum-crc32c - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC32C' - - name: x-amz-fwd-header-x-amz-checksum-crc64nvme - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumCRC64NVME' - - name: x-amz-fwd-header-x-amz-checksum-sha1 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA1' - - name: x-amz-fwd-header-x-amz-checksum-sha256 - in: header - required: false - schema: - $ref: '#/components/schemas/ChecksumSHA256' - - name: x-amz-fwd-header-x-amz-delete-marker - in: header - required: false - schema: - $ref: '#/components/schemas/DeleteMarker' - - name: x-amz-fwd-header-ETag - in: header - required: false - schema: - $ref: '#/components/schemas/ETag' - - name: x-amz-fwd-header-Expires - in: header - required: false - schema: - $ref: '#/components/schemas/Expires' - - name: x-amz-fwd-header-x-amz-expiration - in: header - required: false - schema: - $ref: '#/components/schemas/Expiration' - - name: x-amz-fwd-header-Last-Modified - in: header - required: false - schema: - $ref: '#/components/schemas/LastModified' - - name: x-amz-fwd-header-x-amz-missing-meta - in: header - required: false - schema: - $ref: '#/components/schemas/MissingMeta' - - name: x-amz-fwd-header-x-amz-object-lock-mode - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockMode' - - name: x-amz-fwd-header-x-amz-object-lock-legal-hold - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - - name: x-amz-fwd-header-x-amz-object-lock-retain-until-date - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - - name: x-amz-fwd-header-x-amz-mp-parts-count - in: header - required: false - schema: - $ref: '#/components/schemas/PartsCount' - - name: x-amz-fwd-header-x-amz-replication-status - in: header - required: false - schema: - $ref: '#/components/schemas/ReplicationStatus' - - name: x-amz-fwd-header-x-amz-request-charged - in: header - required: false - schema: - $ref: '#/components/schemas/RequestCharged' - - name: x-amz-fwd-header-x-amz-restore - in: header - required: false - schema: - $ref: '#/components/schemas/Restore' - - name: x-amz-fwd-header-x-amz-server-side-encryption - in: header - required: false - schema: - $ref: '#/components/schemas/ServerSideEncryption' - - name: x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerAlgorithm' - - name: x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id - in: header - required: false - schema: - $ref: '#/components/schemas/SSEKMSKeyId' - - name: x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5 - in: header - required: false - schema: - $ref: '#/components/schemas/SSECustomerKeyMD5' - - name: x-amz-fwd-header-x-amz-storage-class - in: header - required: false - schema: - $ref: '#/components/schemas/StorageClass' - - name: x-amz-fwd-header-x-amz-tagging-count - in: header - required: false - schema: - $ref: '#/components/schemas/TagCount' - - name: x-amz-fwd-header-x-amz-version-id - in: header - required: false - schema: - $ref: '#/components/schemas/ObjectVersionId' - - name: x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled - in: header - required: false - schema: - $ref: '#/components/schemas/BucketKeyEnabled' - requestBody: - required: true - content: - application/xml: - schema: - $ref: '#/components/schemas/StreamingBlob' - responses: - '200': - description: Success -components: - schemas: - AbacInputOverride: - type: object - description: A convenience for presentation - properties: - line_items: - type: array - items: - $ref: '#/components/schemas/AbacInputOverrideJunk' - status: - type: string - AbacInputOverrideJunk: - type: object - properties: - comment: - type: string - source: - type: string - id: - type: number - AbacStatus: - type: object - properties: - Status: - $ref: '#/components/schemas/BucketAbacStatus' - description: The ABAC status of the general purpose bucket. - description: The ABAC status of the general purpose bucket. When ABAC is enabled - for the general purpose bucket, you can use tags to manage access to the general - purpose buckets as well as for cost tracking purposes. When ABAC is disabled - for the general purpose buckets, you can only use tags for cost tracking purposes. - For more information, see [Using tags with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html). - AbortDate: - type: string - format: date-time - AbortIncompleteMultipartUpload: - type: object - properties: - DaysAfterInitiation: - $ref: '#/components/schemas/DaysAfterInitiation' - description: Specifies the number of days after which Amazon S3 aborts an - incomplete multipart upload. - description: Specifies the days since the initiation of an incomplete multipart - upload that Amazon S3 will wait before permanently removing all parts of the - upload. For more information, see [ Aborting Incomplete Multipart Uploads - Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) - in the _Amazon S3 User Guide_. - AbortMultipartUploadOutput: - type: object - properties: - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - AbortMultipartUploadRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Key of the object for which the multipart upload was initiated. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: Upload ID that identifies the multipart upload. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - IfMatchInitiatedTime: - $ref: '#/components/schemas/IfMatchInitiatedTime' - description: 'If present, this header aborts an in progress multipart upload - only if it was initiated on the provided timestamp. If the initiated timestamp - of the multipart upload does not match the provided value, the operation - returns a `412 Precondition Failed` error. If the initiated timestamp - matches or if the multipart upload doesn’t exist, the operation returns - a `204 Success (No Content)` response. - - - This functionality is only supported for directory buckets.' - required: - - Bucket - - Key - - UploadId - AbortRuleId: - type: string - AccelerateConfiguration: - type: object - properties: - Status: - $ref: '#/components/schemas/BucketAccelerateStatus' - description: Specifies the transfer acceleration status of the bucket. - description: Configures the transfer acceleration state for an Amazon S3 bucket. - For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) - in the _Amazon S3 User Guide_. - AcceptRanges: - type: string - AccessControlPolicy: - type: object - properties: - Grants: - $ref: '#/components/schemas/Grants' - description: A list of grants. - Owner: - $ref: '#/components/schemas/Owner' - description: Container for the bucket owner's display name and ID. - description: Contains the elements that set the ACL permissions for an object - per grantee. - AccessControlTranslation: - type: object - properties: - Owner: - $ref: '#/components/schemas/OwnerOverride' - description: Specifies the replica ownership. For default and valid values, - see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) - in the _Amazon S3 API Reference_. - required: - - Owner - description: A container for information about access control for replicas. - AccessKeyIdValue: - type: string - AccessPointAlias: - type: boolean - AccessPointArn: - type: string - AccountId: - type: string - AllowQuotedRecordDelimiter: - type: boolean - AllowedHeader: - type: string - AllowedHeaders: - type: array - items: - $ref: '#/components/schemas/AllowedHeader' - AllowedMethod: - type: string - AllowedMethods: - type: array - items: - $ref: '#/components/schemas/AllowedMethod' - AllowedOrigin: - type: string - AllowedOrigins: - type: array - items: - $ref: '#/components/schemas/AllowedOrigin' - AnalyticsAndOperator: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'The prefix to use when evaluating an AND predicate: The prefix - that an object must have to be included in the metrics results.' - Tags: - $ref: '#/components/schemas/TagSet' - description: The list of tags to use when evaluating an AND predicate. - description: A conjunction (logical AND) of predicates, which is used in evaluating - a metrics filter. The operator must have at least two predicates in any combination, - and an object must match all of the predicates for the filter to apply. - AnalyticsConfiguration: - type: object - properties: - Id: - $ref: '#/components/schemas/AnalyticsId' - description: The ID that identifies the analytics configuration. - Filter: - $ref: '#/components/schemas/AnalyticsFilter' - description: The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - StorageClassAnalysis: - $ref: '#/components/schemas/StorageClassAnalysis' - description: Contains data related to access patterns to be collected and - made available to analyze the tradeoffs between different storage classes. - required: - - Id - - StorageClassAnalysis - description: Specifies the configuration and any analyses for the analytics - filter of an Amazon S3 bucket. - AnalyticsConfigurationList: - type: array - items: - $ref: '#/components/schemas/AnalyticsConfiguration' - AnalyticsExportDestination: - type: object - properties: - S3BucketDestination: - $ref: '#/components/schemas/AnalyticsS3BucketDestination' - description: A destination signifying output to an S3 bucket. - required: - - S3BucketDestination - description: Where to publish the analytics results. - AnalyticsFilter: - allOf: - - $ref: '#/components/schemas/Prefix' - description: |- - The prefix to use when evaluating an analytics filter. - - $ref: '#/components/schemas/Tag' - description: |- - The tag to use when evaluating an analytics filter. - - $ref: '#/components/schemas/AnalyticsAndOperator' - description: |- - A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates. - description: |- - The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis. - AnalyticsId: - type: string - AnalyticsS3BucketDestination: - type: object - properties: - Format: - $ref: '#/components/schemas/AnalyticsS3ExportFileFormat' - description: Specifies the file format used when exporting data to Amazon - S3. - BucketAccountId: - $ref: '#/components/schemas/AccountId' - description: 'The account ID that owns the destination S3 bucket. If no - account ID is provided, the owner is not validated before exporting data. - - - Although this value is optional, we strongly recommend that you set it - to help prevent problems if the destination bucket ownership changes.' - Bucket: - $ref: '#/components/schemas/BucketName' - description: The Amazon Resource Name (ARN) of the bucket to which data - is exported. - Prefix: - $ref: '#/components/schemas/Prefix' - description: The prefix to use when exporting data. The prefix is prepended - to all results. - required: - - Format - - Bucket - description: Contains information about where to publish the analytics results. - AnalyticsS3ExportFileFormat: - type: string - enum: - - CSV - ArchiveStatus: - type: string - enum: - - ARCHIVE_ACCESS - - DEEP_ARCHIVE_ACCESS - BlockedEncryptionTypes: - type: object - properties: - EncryptionType: - $ref: '#/components/schemas/EncryptionTypeList' - description: 'The object encryption type that you want to block or unblock - for an Amazon S3 general purpose bucket. - - - Currently, this parameter only supports blocking or unblocking server - side encryption with customer-provided keys (SSE-C). For more information - about SSE-C, see [Using server-side encryption with customer-provided - keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).' - description: "A bucket-level setting for Amazon S3 general purpose buckets used\ - \ to prevent the upload of new objects encrypted with the specified server-side\ - \ encryption type. For example, blocking an encryption type will block `PutObject`,\ - \ `CopyObject`, `PostObject`, multipart upload, and replication requests to\ - \ the bucket for objects with the specified encryption type. However, you\ - \ can continue to read and list any pre-existing objects already encrypted\ - \ with the specified encryption type. For more information, see [Blocking\ - \ or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).\n\ - \nThis data type is used with the following actions:\n\n * [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)\n\ - \n * [GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)\n\ - \n * [DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)\n\ - \nPermissions\n\n \n\nYou must have the `s3:PutEncryptionConfiguration`\ - \ permission to block or unblock an encryption type for a bucket.\n\nYou must\ - \ have the `s3:GetEncryptionConfiguration` permission to view a bucket's encryption\ - \ type." - Body: - type: string - format: byte - Bucket: - type: object - properties: - Name: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket. - CreationDate: - $ref: '#/components/schemas/CreationDate' - description: Date the bucket was created. This date can change when making - changes to your bucket, such as editing its bucket policy. - BucketRegion: - $ref: '#/components/schemas/BucketRegion' - description: '`BucketRegion` indicates the Amazon Web Services region where - the bucket is located. If the request contains at least one valid parameter, - it is included in the response.' - BucketArn: - $ref: '#/components/schemas/S3RegionalOrS3ExpressBucketArnString' - description: 'The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely - identify Amazon Web Services resources across all of Amazon Web Services. - - - This parameter is only supported for S3 directory buckets. For more information, - see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).' - description: In terms of implementation, a Bucket is a resource. - BucketAbacStatus: - type: string - enum: - - Enabled - - Disabled - BucketAccelerateStatus: - type: string - enum: - - Enabled - - Suspended - BucketAlreadyExists: - type: object - properties: {} - description: 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. - BucketAlreadyOwnedByYou: - type: object - properties: {} - description: 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). - BucketCannedACL: - type: string - enum: - - private - - public-read - - public-read-write - - authenticated-read - BucketInfo: - type: object - properties: - DataRedundancy: - $ref: '#/components/schemas/DataRedundancy' - description: The number of Zone (Availability Zone or Local Zone) that's - used for redundancy for the bucket. - Type: - $ref: '#/components/schemas/BucketType' - description: The type of bucket. - description: 'Specifies the information about the bucket that will be created. - For more information about directory buckets, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) - in the _Amazon S3 User Guide_. - - - This functionality is only supported by directory buckets.' - BucketKeyEnabled: - type: boolean - BucketLifecycleConfiguration: - type: object - properties: - Rules: - $ref: '#/components/schemas/LifecycleRules' - description: A lifecycle rule for individual objects in an Amazon S3 bucket. - required: - - Rules - description: Specifies the lifecycle configuration for objects in an Amazon - S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) - in the _Amazon S3 User Guide_. - BucketLocationConstraint: - type: string - enum: - - af-south-1 - - ap-east-1 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-south-1 - - ap-south-2 - - ap-southeast-1 - - ap-southeast-2 - - ap-southeast-3 - - ap-southeast-4 - - ap-southeast-5 - - ca-central-1 - - cn-north-1 - - cn-northwest-1 - - EU - - eu-central-1 - - eu-central-2 - - eu-north-1 - - eu-south-1 - - eu-south-2 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - il-central-1 - - me-central-1 - - me-south-1 - - sa-east-1 - - us-east-2 - - us-gov-east-1 - - us-gov-west-1 - - us-west-1 - - us-west-2 - BucketLocationName: - type: string - BucketLoggingStatus: - type: object - properties: - LoggingEnabled: - $ref: '#/components/schemas/LoggingEnabled' - description: Container for logging status information. - BucketLogsPermission: - type: string - enum: - - FULL_CONTROL - - READ - - WRITE - BucketName: - type: string - BucketRegion: - type: string - BucketType: - type: string - enum: - - Directory - BucketVersioningStatus: - type: string - enum: - - Enabled - - Suspended - Buckets: - type: array - items: - allOf: - - $ref: '#/components/schemas/Bucket' - - xml: - name: Bucket - - BypassGovernanceRetention: - type: boolean - BytesProcessed: - type: integer - format: int64 - BytesReturned: - type: integer - format: int64 - BytesScanned: - type: integer - format: int64 - CORSConfiguration: - type: object - properties: - CORSRules: - $ref: '#/components/schemas/CORSRules' - description: A set of origins and methods (cross-origin access that you - want to allow). You can add up to 100 rules to the configuration. - required: - - CORSRules - description: Describes the cross-origin access configuration for objects in - an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource - Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the - _Amazon S3 User Guide_. - CORSRule: - type: object - properties: - ID: - $ref: '#/components/schemas/ID' - description: Unique identifier for the rule. The value cannot be longer - than 255 characters. - AllowedHeaders: - $ref: '#/components/schemas/AllowedHeaders' - description: Headers that are specified in the `Access-Control-Request-Headers` - header. These headers are allowed in a preflight OPTIONS request. In response - to any preflight OPTIONS request, Amazon S3 returns any requested headers - that are allowed. - AllowedMethods: - $ref: '#/components/schemas/AllowedMethods' - description: An HTTP method that you allow the origin to execute. Valid - values are `GET`, `PUT`, `HEAD`, `POST`, and `DELETE`. - AllowedOrigins: - $ref: '#/components/schemas/AllowedOrigins' - description: One or more origins you want customers to be able to access - the bucket from. - ExposeHeaders: - $ref: '#/components/schemas/ExposeHeaders' - description: One or more headers in the response that you want customers - to be able to access from their applications (for example, from a JavaScript - `XMLHttpRequest` object). - MaxAgeSeconds: - $ref: '#/components/schemas/MaxAgeSeconds' - description: The time in seconds that your browser is to cache the preflight - response for the specified resource. - required: - - AllowedMethods - - AllowedOrigins - description: Specifies a cross-origin access rule for an Amazon S3 bucket. - CORSRules: - type: array - items: - $ref: '#/components/schemas/CORSRule' - CSVInput: - type: object - properties: - FileHeaderInfo: - $ref: '#/components/schemas/FileHeaderInfo' - description: "Describes the first line of input. Valid values are:\n\n \ - \ * `NONE`: First line is not a header.\n\n * `IGNORE`: First line is\ - \ a header, but you can't use the header values to indicate the column\ - \ in an expression. You can use column position (such as _1, _2, …) to\ - \ indicate the column (`SELECT s._1 FROM OBJECT s`).\n\n * `Use`: First\ - \ line is a header, and you can use the header value to identify a column\ - \ in an expression (`SELECT \"name\" FROM OBJECT`)." - Comments: - $ref: '#/components/schemas/Comments' - description: 'A single character used to indicate that a row should be ignored - when the character is present at the start of that row. You can specify - any character to indicate a comment line. The default character is `#`. - - - Default: `#`' - QuoteEscapeCharacter: - $ref: '#/components/schemas/QuoteEscapeCharacter' - description: A single character used for escaping the quotation mark character - inside an already escaped value. For example, the value `""" a , b """` - is parsed as `" a , b "`. - RecordDelimiter: - $ref: '#/components/schemas/RecordDelimiter' - description: A single character used to separate individual records in the - input. Instead of the default value, you can specify an arbitrary delimiter. - FieldDelimiter: - $ref: '#/components/schemas/FieldDelimiter' - description: A single character used to separate individual fields in a - record. You can specify an arbitrary delimiter. - QuoteCharacter: - $ref: '#/components/schemas/QuoteCharacter' - description: 'A single character used for escaping when the field delimiter - is part of the value. For example, if the value is `a, b`, Amazon S3 wraps - this field value in quotation marks, as follows: `" a , b "`. - - - Type: String - - - Default: `"` - - - Ancestors: `CSV`' - AllowQuotedRecordDelimiter: - $ref: '#/components/schemas/AllowQuotedRecordDelimiter' - description: Specifies that CSV field values may contain quoted record delimiters - and such records should be allowed. Default value is FALSE. Setting this - value to TRUE may lower performance. - description: Describes how an uncompressed comma-separated values (CSV)-formatted - input object is formatted. - CSVOutput: - type: object - properties: - QuoteFields: - $ref: '#/components/schemas/QuoteFields' - description: "Indicates whether to use quotation marks around output fields.\n\ - \n * `ALWAYS`: Always use quotation marks for output fields.\n\n * `ASNEEDED`:\ - \ Use quotation marks for output fields when needed." - QuoteEscapeCharacter: - $ref: '#/components/schemas/QuoteEscapeCharacter' - description: The single character used for escaping the quote character - inside an already escaped value. - RecordDelimiter: - $ref: '#/components/schemas/RecordDelimiter' - description: A single character used to separate individual records in the - output. Instead of the default value, you can specify an arbitrary delimiter. - FieldDelimiter: - $ref: '#/components/schemas/FieldDelimiter' - description: The value used to separate individual fields in a record. You - can specify an arbitrary delimiter. - QuoteCharacter: - $ref: '#/components/schemas/QuoteCharacter' - description: 'A single character used for escaping when the field delimiter - is part of the value. For example, if the value is `a, b`, Amazon S3 wraps - this field value in quotation marks, as follows: `" a , b "`.' - description: Describes how uncompressed comma-separated values (CSV)-formatted - results are formatted. - CacheControl: - type: string - Checksum: - type: object - properties: - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. - This checksum is present if the object was uploaded with the `CRC64NVME` - checksum algorithm, or if the object was uploaded without a checksum (and - Amazon S3 added the default checksum, `CRC64NVME`, to the uploaded object). - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type that is used to calculate the object’s checksum - value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - description: Contains all the possible checksum or digest values for an object. - ChecksumAlgorithm: - type: string - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - - CRC64NVME - ChecksumAlgorithmList: - type: array - items: - $ref: '#/components/schemas/ChecksumAlgorithm' - ChecksumCRC32: - type: string - ChecksumCRC32C: - type: string - ChecksumCRC64NVME: - type: string - ChecksumMode: - type: string - enum: - - ENABLED - ChecksumSHA1: - type: string - ChecksumSHA256: - type: string - ChecksumType: - type: string - enum: - - COMPOSITE - - FULL_OBJECT - ClientToken: - type: string - Code: - type: string - Comments: - type: string - CommonPrefix: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: Container for the specified common prefix. - description: Container for 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/. - CommonPrefixList: - type: array - items: - $ref: '#/components/schemas/CommonPrefix' - CompleteMultipartUploadOutput: - type: object - properties: - Location: - $ref: '#/components/schemas/Location' - description: The URI that identifies the newly created object. - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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: - $ref: '#/components/schemas/ObjectKey' - description: The object key of the newly created object. - Expiration: - $ref: '#/components/schemas/Expiration' - description: '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.' - ETag: - $ref: '#/components/schemas/ETag' - description: Entity tag that identifies the newly created object's data. - Objects with different object data will have different entity tags. The - entity tag is an opaque string. The entity tag may or may not be an MD5 - digest of the object data. If the entity tag is not an MD5 digest of the - object data, it will contain one or more nonhexadecimal characters and/or - will consist of less than 32 or more than 32 hexadecimal digits. For more - information about how the entity tag is calculated, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the - object. The `CRC64NVME` checksum is always a full object checksum. For - more information, see [Checking object integrity in the Amazon S3 User - Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type, which determines how part-level checksums - are combined to create an object-level checksum for multipart objects. - You can use this header as a data integrity check to verify that the checksum - type that is received is the same checksum type that was specified during - the `CreateMultipartUpload` request. For more information, see [Checking - object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when storing this - object in Amazon S3. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID of the newly created object, in case the bucket - has versioning turned on. - - - This functionality is not supported for directory buckets.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the multipart upload uses an S3 Bucket Key - for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - CompleteMultipartUploadRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload was initiated. - MultipartUpload: - $ref: '#/components/schemas/CompletedMultipartUpload' - description: The container for the multipart upload request information. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: ID for the initiated multipart upload. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32` checksum of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the - object. The `CRC64NVME` checksum is always a full object checksum. For - more information, see [Checking object integrity in the Amazon S3 User - Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 160-bit `SHA1` digest of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 256-bit `SHA256` digest of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: This header specifies the checksum type of the object, which - determines how part-level checksums are combined to create an object-level - checksum for multipart objects. You can use this header as a data integrity - check to verify that the checksum type that is received is the same checksum - that was specified. If the checksum type doesn’t match the checksum type - that was specified for the object during the `CreateMultipartUpload` request, - it’ll result in a `BadDigest` error. For more information, see Checking - object integrity in the Amazon S3 User Guide. - MpuObjectSize: - $ref: '#/components/schemas/MpuObjectSize' - description: The expected total object size of the multipart upload request. - If there’s a mismatch between the specified object size value and the - actual object size value, it results in an `HTTP 400 InvalidRequest` error. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - IfMatch: - $ref: '#/components/schemas/IfMatch' - description: 'Uploads the object only if the ETag (entity tag) value provided - during the WRITE operation matches the ETag of the object in S3. If the - ETag values do not match, the operation returns a `412 Precondition Failed` - error. - - - If a conflicting operation occurs during the upload S3 returns a `409 - ConditionalRequestConflict` response. On a 409 failure you should fetch - the object''s ETag, re-initiate the multipart upload with `CreateMultipartUpload`, - and re-upload each part. - - - Expects the ETag value as a string. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), - or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) - in the _Amazon S3 User Guide_.' - IfNoneMatch: - $ref: '#/components/schemas/IfNoneMatch' - description: 'Uploads the object only if the object key name does not already - exist in the bucket specified. Otherwise, Amazon S3 returns a `412 Precondition - Failed` error. - - - If a conflicting operation occurs during the upload S3 returns a `409 - ConditionalRequestConflict` response. On a 409 failure you should re-initiate - the multipart upload with `CreateMultipartUpload` and re-upload each part. - - - Expects the ''*'' (asterisk) character. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), - or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) - in the _Amazon S3 User Guide_.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - required: - - Bucket - - Key - - UploadId - CompletedMultipartUpload: - type: object - properties: - Parts: - $ref: '#/components/schemas/CompletedPartList' - description: 'Array of CompletedPart data types. - - - If you do not supply a valid `Part` with your request, the service sends - back an HTTP 400 response.' - description: The container for the completed multipart upload details. - CompletedPart: - type: object - properties: - ETag: - $ref: '#/components/schemas/ETag' - description: Entity tag returned when the part was uploaded. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32` checksum of the part. This - checksum is present if the multipart upload request was created with the - `CRC32` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the part. This - checksum is present if the multipart upload request was created with the - `CRC32C` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. - This checksum is present if the multipart upload request was created with - the `CRC64NVME` checksum algorithm to the uploaded object). For more information, - see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` checksum of the part. This - checksum is present if the multipart upload request was created with the - `SHA1` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` checksum of the part. - This checksum is present if the multipart upload request was created with - the `SHA256` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: "Part number that identifies the part. This is a positive integer\ - \ between 1 and 10,000.\n\n * **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.\n\n * **Directory\ - \ buckets** \\- In `CompleteMultipartUpload`, the `PartNumber` must start\ - \ at 1 and the part numbers must be consecutive." - description: Details of the parts that were uploaded. - CompletedPartList: - type: array - items: - $ref: '#/components/schemas/CompletedPart' - CompressionType: - type: string - enum: - - NONE - - GZIP - - BZIP2 - Condition: - type: object - properties: - HttpErrorCodeReturnedEquals: - $ref: '#/components/schemas/HttpErrorCodeReturnedEquals' - description: The HTTP error code when the redirect is applied. In the event - of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element `Condition` is specified and - sibling `KeyPrefixEquals` is not specified. If both are specified, then - both must be true for the redirect to be applied. - KeyPrefixEquals: - $ref: '#/components/schemas/KeyPrefixEquals' - description: 'The object key name prefix when the redirect is applied. For - example, to redirect requests for `ExamplePage.html`, the key prefix will - be `ExamplePage.html`. To redirect request for all pages with the prefix - `docs/`, the key prefix will be `/docs`, which identifies all objects - in the `docs/` folder. Required when the parent element `Condition` is - specified and sibling `HttpErrorCodeReturnedEquals` is not specified. - If both conditions are specified, both must be true for the redirect to - be applied. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - description: A container for describing a condition that must be met for the - specified redirect to apply. For example, 1. If request is for pages in the - `/docs` folder, redirect to the `/documents` folder. 2. If request results - in HTTP error 4xx, redirect request to another host where you might process - the error. - ConfirmRemoveSelfBucketAccess: - type: boolean - ContentDisposition: - type: string - ContentEncoding: - type: string - ContentLanguage: - type: string - ContentLength: - type: integer - format: int64 - ContentMD5: - type: string - ContentRange: - type: string - ContentType: - type: string - ContinuationEvent: - type: object - properties: {} - description: '' - CopyObjectOutput: - type: object - properties: - CopyObjectResult: - $ref: '#/components/schemas/CopyObjectResult' - description: Container for all response elements. - Expiration: - $ref: '#/components/schemas/Expiration' - description: 'If the object expiration is configured, the response includes - this header. - - - Object expiration information is not returned in directory buckets and - this header returns the value "`NotImplemented`" in all responses for - directory buckets.' - CopySourceVersionId: - $ref: '#/components/schemas/CopySourceVersionId' - description: 'Version ID of the source object that was copied. - - - This functionality is not supported when the source object is in a directory - bucket.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID of the newly created copy. - - - This functionality is not supported for directory buckets.' - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: 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. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the copied object uses an S3 Bucket Key for - server-side encryption with Key Management Service (KMS) keys (SSE-KMS). - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - CopyObjectRequest: - type: object - properties: - ACL: - $ref: '#/components/schemas/ObjectCannedACL' - description: "The canned access control list (ACL) to apply to the object.\n\ - \nWhen 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).\n\ - \nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ - \ in the _Amazon S3 User Guide_.\n\n * 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.\n\ - \n * This functionality is not supported for directory buckets.\n\n \ - \ * This functionality is not supported for Amazon S3 on Outposts." - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - Copying objects across different Amazon Web Services Regions isn''t supported - when the source or destination bucket is in Amazon Web Services Local - Zones. The source and destination buckets must have the same parent Amazon - Web Services Region. Otherwise, you get an HTTP `400 Bad Request` error - with the error code `InvalidRequest`. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with S3 on Outposts, you - must use the Outpost bucket access point ARN or the access point alias - for the destination bucket. You can only copy objects within the same - Outpost bucket. It''s not supported to copy objects across different Amazon - Web Services Outposts, between buckets on the same Outposts, or between - Outposts buckets and any other bucket types. For more information about - S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _S3 on Outposts guide_. When you use this action with S3 on Outposts - through the REST API, you must direct requests to the S3 on Outposts hostname, - in the format ` _AccessPointName_ -_AccountId_._outpostID_.s3-outposts._Region_.amazonaws.com`. - The hostname isn''t required when you use the Amazon Web Services CLI - or SDKs.' - CacheControl: - $ref: '#/components/schemas/CacheControl' - description: Specifies the caching behavior along the request/reply chain. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm that you want Amazon S3 to use to - create the checksum for the object. For more information, see [Checking - object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - 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.' - ContentDisposition: - $ref: '#/components/schemas/ContentDisposition' - description: 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. - ContentEncoding: - $ref: '#/components/schemas/ContentEncoding' - description: '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.' - ContentLanguage: - $ref: '#/components/schemas/ContentLanguage' - description: The language the content is in. - ContentType: - $ref: '#/components/schemas/ContentType' - description: A standard MIME type that describes the format of the object - data. - CopySource: - $ref: '#/components/schemas/CopySource' - description: "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.\n\ - \nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):\n\ - \n * 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.\n\n * 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:::accesspoint//object/`.\ - \ 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.\n\n * Amazon S3 supports copy operations\ - \ using Access points only when the source and destination buckets are\ - \ in the same Amazon Web Services Region.\n\n * Access points are not\ - \ supported by directory buckets.\n\nAlternatively, for objects accessed\ - \ through Amazon S3 on Outposts, specify the ARN of the object as accessed\ - \ in the format `arn:aws:s3-outposts:::outpost//object/`. 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.\n\nIf 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=`\ - \ 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.\n\nIf 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.\n\nIf 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.\n\ - \n**Directory buckets** \\- S3 Versioning isn't enabled and supported\ - \ for directory buckets." - CopySourceIfMatch: - $ref: '#/components/schemas/CopySourceIfMatch' - description: "Copies the object if its entity tag (ETag) matches the specified\ - \ tag.\n\nIf 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:\n\n * `x-amz-copy-source-if-match`\ - \ condition evaluates to true\n\n * `x-amz-copy-source-if-unmodified-since`\ - \ condition evaluates to false" - CopySourceIfModifiedSince: - $ref: '#/components/schemas/CopySourceIfModifiedSince' - description: "Copies the object if it has been modified since the specified\ - \ time.\n\nIf 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:\n\n * `x-amz-copy-source-if-none-match`\ - \ condition evaluates to false\n\n * `x-amz-copy-source-if-modified-since`\ - \ condition evaluates to true" - CopySourceIfNoneMatch: - $ref: '#/components/schemas/CopySourceIfNoneMatch' - description: "Copies the object if its entity tag (ETag) is different than\ - \ the specified ETag.\n\nIf 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:\n\n * `x-amz-copy-source-if-none-match` condition\ - \ evaluates to false\n\n * `x-amz-copy-source-if-modified-since` condition\ - \ evaluates to true" - CopySourceIfUnmodifiedSince: - $ref: '#/components/schemas/CopySourceIfUnmodifiedSince' - description: "Copies the object if it hasn't been modified since the specified\ - \ time.\n\nIf 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:\n\n * `x-amz-copy-source-if-match`\ - \ condition evaluates to true\n\n * `x-amz-copy-source-if-unmodified-since`\ - \ condition evaluates to false" - Expires: - $ref: '#/components/schemas/Expires' - description: The date and time at which the object is no longer cacheable. - GrantFullControl: - $ref: '#/components/schemas/GrantFullControl' - description: "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions\ - \ on the object.\n\n * This functionality is not supported for directory\ - \ buckets.\n\n * This functionality is not supported for Amazon S3 on\ - \ Outposts." - GrantRead: - $ref: '#/components/schemas/GrantRead' - description: "Allows grantee to read the object data and its metadata.\n\ - \n * This functionality is not supported for directory buckets.\n\n \ - \ * This functionality is not supported for Amazon S3 on Outposts." - GrantReadACP: - $ref: '#/components/schemas/GrantReadACP' - description: "Allows grantee to read the object ACL.\n\n * This functionality\ - \ is not supported for directory buckets.\n\n * This functionality is\ - \ not supported for Amazon S3 on Outposts." - GrantWriteACP: - $ref: '#/components/schemas/GrantWriteACP' - description: "Allows grantee to write the ACL for the applicable object.\n\ - \n * This functionality is not supported for directory buckets.\n\n \ - \ * This functionality is not supported for Amazon S3 on Outposts." - IfMatch: - $ref: '#/components/schemas/IfMatch' - description: 'Copies the object if the entity tag (ETag) of the destination - object matches the specified tag. If the ETag values do not match, the - operation returns a `412 Precondition Failed` error. If a concurrent operation - occurs during the upload S3 returns a `409 ConditionalRequestConflict` - response. On a 409 failure you should fetch the object''s ETag and retry - the upload. - - - Expects the ETag value as a string. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).' - IfNoneMatch: - $ref: '#/components/schemas/IfNoneMatch' - description: 'Copies the object only if the object key name at the destination - does not already exist in the bucket specified. Otherwise, Amazon S3 returns - a `412 Precondition Failed` error. If a concurrent operation occurs during - the upload S3 returns a `409 ConditionalRequestConflict` response. On - a 409 failure you should retry the upload. - - - Expects the ''*'' (asterisk) character. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key of the destination object. - Metadata: - $ref: '#/components/schemas/Metadata' - description: A map of metadata to store with the object in S3. - MetadataDirective: - $ref: '#/components/schemas/MetadataDirective' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) - 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.' - TaggingDirective: - $ref: '#/components/schemas/TaggingDirective' - description: "Specifies whether the object tag-set is copied from the source\ - \ object or replaced with the tag-set that's provided in the request.\n\ - \nThe default value is `COPY`.\n\n**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:\n\n * When you attempt\ - \ to `COPY` the tag-set from an S3 source object that has non-empty tags.\n\ - \n * When you attempt to `REPLACE` the tag-set of a source object and\ - \ set a non-empty value to `x-amz-tagging`.\n\n * 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`.\n\nBecause only the empty tag-set is supported for directory\ - \ buckets in a `CopyObject` operation, the following situations are allowed:\n\ - \n * 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.\n\n * 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.\n\n * 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.\n\n * 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." - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: "The server-side encryption algorithm used when storing this\ - \ object in Amazon S3. Unrecognized or unsupported values won’t write\ - \ a destination object and will receive a `400 Bad Request` response.\n\ - \nAmazon 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 different default encryption configuration,\ - \ Amazon S3 uses the corresponding encryption key to encrypt the target\ - \ object copy.\n\nWith 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n**General purpose buckets**\n\n *\ - \ For general purpose buckets, there are the following supported options\ - \ for server-side encryption: server-side encryption with Key Management\ - \ Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with\ - \ Amazon Web Services KMS keys (DSSE-KMS), and 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.\n\ - \n * 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. \n\n**Directory buckets**\n\ - \n * For directory buckets, there are only two supported options for\ - \ server-side encryption: server-side encryption with Amazon S3 managed\ - \ keys (SSE-S3) (`AES256`) and server-side encryption with KMS keys (SSE-KMS)\ - \ (`aws:kms`). We recommend that the bucket's default encryption uses\ - \ the desired encryption configuration and you don't override the bucket\ - \ default encryption in your `CreateSession` requests or `PUT` object\ - \ requests. Then, new objects are automatically encrypted with the desired\ - \ encryption settings. For more information, see [Protecting data with\ - \ server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_. For more information about the encryption\ - \ overriding behaviors in directory buckets, see [Specifying server-side\ - \ encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\n\ - \n * To encrypt new object copies to a directory bucket with SSE-KMS,\ - \ we recommend you specify SSE-KMS as the directory bucket's default encryption\ - \ configuration with a KMS key (specifically, a [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)).\ - \ The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\ - \ (`aws/s3`) isn't supported. Your SSE-KMS configuration can only support\ - \ 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ per directory bucket for the lifetime of the bucket. After you specify\ - \ a customer managed key for SSE-KMS, you can't override the customer\ - \ managed key for the bucket's SSE-KMS configuration. Then, when you perform\ - \ a `CopyObject` operation and want to specify server-side encryption\ - \ settings for new object copies with SSE-KMS in the encryption-related\ - \ request headers, you must ensure the encryption key is the same customer\ - \ managed key that you specified for the directory bucket's default encryption\ - \ configuration. \n\n * **S3 access points for Amazon FSx** \\- When\ - \ accessing data stored in Amazon FSx file systems using S3 access points,\ - \ the only valid server side encryption option is `aws:fsx`. All Amazon\ - \ FSx file systems have encryption configured by default and are encrypted\ - \ at rest. Data is automatically encrypted before being written to the\ - \ file system, and automatically decrypted as it is read. These processes\ - \ are handled transparently by Amazon FSx." - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: "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.\n\n * **Directory buckets** \\- Directory buckets only support\ - \ `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability\ - \ Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class)\ - \ in Dedicated Local Zones. Unsupported storage class values won't write\ - \ a destination object and will respond with the HTTP status code `400\ - \ Bad Request`.\n\n * **Amazon S3 on Outposts** \\- S3 on Outposts only\ - \ uses the `OUTPOSTS` Storage Class.\n\nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)\ - \ in the _Amazon S3 User Guide_.\n\nBefore 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:\n\n * The storage class of the source\ - \ object is `GLACIER` or `DEEP_ARCHIVE`.\n\n * The storage class of the\ - \ source object is `INTELLIGENT_TIERING` and it's [S3 Intelligent-Tiering\ - \ access tier](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition)\ - \ is `Archive Access` or `Deep Archive Access`.\n\nFor more information,\ - \ see [RestoreObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html)\ - \ and [Copying Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html)\ - \ in the _Amazon S3 User Guide_." - WebsiteRedirectLocation: - $ref: '#/components/schemas/WebsiteRedirectLocation' - description: '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.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: 'Specifies the KMS key 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) - in the _Amazon S3 User Guide_. - - - **Directory buckets** \- To encrypt data using SSE-KMS, it''s recommended - to specify the `x-amz-server-side-encryption` header to `aws:kms`. Then, - the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses - the bucket''s default KMS customer managed key ID. If you want to explicitly - set the ` x-amz-server-side-encryption-aws-kms-key-id` header, it must - match the bucket''s default customer managed key (using key ID or ARN, - not alias). Your SSE-KMS configuration can only support 1 [customer managed - key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) - per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) - (`aws/s3`) isn''t supported. Incorrect key specification results in an - HTTP `400 Bad Request` error.' - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: 'Specifies the Amazon Web Services KMS Encryption Context as - an additional encryption context to use for the destination object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON - with the encryption context key-value pairs. - - - **General purpose buckets** \- This value must be explicitly added to - specify encryption context for `CopyObject` requests if you want an additional - encryption context for your destination object. The additional encryption - context of the source object won''t be copied to the destination object. - For more information, see [Encryption context](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context) - in the _Amazon S3 User Guide_. - - - **Directory buckets** \- You can optionally provide an explicit encryption - context value. The value must match the default encryption context - the - bucket Amazon Resource Name (ARN). An additional encryption context value - is not supported.' - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) - in the _Amazon S3 User Guide_. - - - **Directory buckets** \- S3 Bucket Keys aren''t supported, when you copy - SSE-KMS encrypted objects from general purpose buckets to directory buckets, - from directory buckets to general purpose buckets, or between directory - buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html). - In this case, Amazon S3 makes a call to KMS every time a copy request - is made for a KMS-encrypted object.' - CopySourceSSECustomerAlgorithm: - $ref: '#/components/schemas/CopySourceSSECustomerAlgorithm' - description: '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.' - CopySourceSSECustomerKey: - $ref: '#/components/schemas/CopySourceSSECustomerKey' - description: '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.' - CopySourceSSECustomerKeyMD5: - $ref: '#/components/schemas/CopySourceSSECustomerKeyMD5' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - Tagging: - $ref: '#/components/schemas/TaggingHeader' - description: "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.\n\ - \nThe default value is the empty value.\n\n**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:\n\ - \n * When you attempt to `COPY` the tag-set from an S3 source object\ - \ that has non-empty tags.\n\n * When you attempt to `REPLACE` the tag-set\ - \ of a source object and set a non-empty value to `x-amz-tagging`.\n\n\ - \ * 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`.\n\nBecause only the empty tag-set is supported for directory\ - \ buckets in a `CopyObject` operation, the following situations are allowed:\n\ - \n * 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.\n\n * 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.\n\n * 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.\n\n * 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." - ObjectLockMode: - $ref: '#/components/schemas/ObjectLockMode' - description: 'The Object Lock mode that you want to apply to the object - copy. - - - This functionality is not supported for directory buckets.' - ObjectLockRetainUntilDate: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - description: 'The date and time when you want the Object Lock of the object - copy to expire. - - - This functionality is not supported for directory buckets.' - ObjectLockLegalHoldStatus: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: 'Specifies whether you want to apply a legal hold to the object - copy. - - - This functionality is not supported for directory buckets.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ExpectedSourceBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - CopySource - - Key - CopyObjectResult: - type: object - properties: - ETag: - $ref: '#/components/schemas/ETag' - description: Returns the ETag of the new object. The ETag reflects only - changes to the contents of an object, not its metadata. - LastModified: - $ref: '#/components/schemas/LastModified' - description: Creation date of the object. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type that is used to calculate the object’s checksum - value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32` checksum of the object. - This checksum is only present if the object was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. - This checksum is present if the object being copied was uploaded with - the `CRC64NVME` checksum algorithm, or if the object was uploaded without - a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to - the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - description: Container for all response elements. - CopyPartResult: - type: object - properties: - ETag: - $ref: '#/components/schemas/ETag' - description: Entity tag of the object. - LastModified: - $ref: '#/components/schemas/LastModified' - description: Date and time at which the object was uploaded. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32` checksum of the part. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the part. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. - This checksum is present if the multipart upload request was created with - the `CRC64NVME` checksum algorithm to the uploaded object). For more information, - see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 160-bit `SHA1` checksum of the part. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 256-bit `SHA256` checksum of the - part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - description: Container for all response elements. - CopySource: - type: string - pattern: ^\/?.+\/.+$ - CopySourceIfMatch: - type: string - CopySourceIfModifiedSince: - type: string - format: date-time - CopySourceIfNoneMatch: - type: string - CopySourceIfUnmodifiedSince: - type: string - format: date-time - CopySourceRange: - type: string - CopySourceSSECustomerAlgorithm: - type: string - CopySourceSSECustomerKey: - type: string - CopySourceSSECustomerKeyMD5: - type: string - CopySourceVersionId: - type: string - CreateBucketConfiguration: - type: object - properties: - LocationConstraint: - $ref: '#/components/schemas/BucketLocationConstraint' - description: '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. - - - If you don''t specify a Region, the bucket is created in the US East (N. - Virginia) Region (us-east-1) by default. Configurations using the value - `EU` will create a bucket in `eu-west-1`. - - - For a list of the valid values for all of the Amazon Web Services Regions, - see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). - - - This functionality is not supported for directory buckets.' - Location: - $ref: '#/components/schemas/LocationInfo' - description: 'Specifies the location where the bucket will be created. - - - **Directory buckets** \- The location type is Availability Zone or Local - Zone. To use the Local Zone location type, your account must be enabled - for Local Zones. Otherwise, you get an HTTP `403 Forbidden` error with - the error code `AccessDenied`. To learn more, see [Enable accounts for - Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/opt-in-directory-bucket-lz.html) - in the _Amazon S3 User Guide_. - - - This functionality is only supported by directory buckets.' - Bucket: - $ref: '#/components/schemas/BucketInfo' - description: 'Specifies the information about the bucket that will be created. - - - This functionality is only supported by directory buckets.' - Tags: - $ref: '#/components/schemas/TagSet' - description: 'An array of tags that you can apply to the bucket that you''re - creating. Tags are key-value pairs of metadata used to categorize and - organize your buckets, track costs, and control access. - - - You must have the `s3:TagResource` permission to create a general purpose - bucket with tags or the `s3express:TagResource` permission to create a - directory bucket with tags. - - - When creating buckets with tags, note that tag-based conditions using - `aws:ResourceTag` and `s3:BucketTag` condition keys are applicable only - after ABAC is enabled on the bucket. To learn more, see [Enabling ABAC - in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html).' - description: The configuration information for the bucket. - CreateBucketMetadataConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that you want to create the metadata - configuration for. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: The `Content-MD5` header for the metadata configuration. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The checksum algorithm to use with your metadata configuration. - MetadataConfiguration: - $ref: '#/components/schemas/MetadataConfiguration' - description: The contents of your metadata configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected owner of the general purpose bucket that corresponds - to your metadata configuration. - required: - - Bucket - - MetadataConfiguration - CreateBucketMetadataTableConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that you want to create the metadata - table configuration for. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: The `Content-MD5` header for the metadata table configuration. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The checksum algorithm to use with your metadata table configuration. - MetadataTableConfiguration: - $ref: '#/components/schemas/MetadataTableConfiguration' - description: The contents of your metadata table configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected owner of the general purpose bucket that corresponds - to your metadata table configuration. - required: - - Bucket - - MetadataTableConfiguration - CreateBucketOutput: - type: object - properties: - Location: - $ref: '#/components/schemas/Location' - description: A forward slash followed by the name of the bucket. - BucketArn: - $ref: '#/components/schemas/S3RegionalOrS3ExpressBucketArnString' - description: 'The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely - identify Amazon Web Services resources across all of Amazon Web Services. - - - This parameter is only supported for S3 directory buckets. For more information, - see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).' - CreateBucketRequest: - type: object - properties: - ACL: - $ref: '#/components/schemas/BucketCannedACL' - description: 'The canned ACL to apply to the bucket. - - - This functionality is not supported for directory buckets.' - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The name of the bucket to create. - - - **General purpose buckets** \- For information about bucket naming restrictions, - see [Bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) - 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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - CreateBucketConfiguration: - $ref: '#/components/schemas/CreateBucketConfiguration' - description: The configuration information for the bucket. - GrantFullControl: - $ref: '#/components/schemas/GrantFullControl' - description: 'Allows grantee the read, write, read ACP, and write ACP permissions - on the bucket. - - - This functionality is not supported for directory buckets.' - GrantRead: - $ref: '#/components/schemas/GrantRead' - description: 'Allows grantee to list the objects in the bucket. - - - This functionality is not supported for directory buckets.' - GrantReadACP: - $ref: '#/components/schemas/GrantReadACP' - description: 'Allows grantee to read the bucket ACL. - - - This functionality is not supported for directory buckets.' - GrantWrite: - $ref: '#/components/schemas/GrantWrite' - description: '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.' - GrantWriteACP: - $ref: '#/components/schemas/GrantWriteACP' - description: 'Allows grantee to write the ACL for the applicable bucket. - - - This functionality is not supported for directory buckets.' - ObjectLockEnabledForBucket: - $ref: '#/components/schemas/ObjectLockEnabledForBucket' - description: 'Specifies whether you want S3 Object Lock to be enabled for - the new bucket. - - - This functionality is not supported for directory buckets.' - ObjectOwnership: - $ref: '#/components/schemas/ObjectOwnership' - required: - - Bucket - CreateMultipartUploadOutput: - type: object - properties: - AbortDate: - $ref: '#/components/schemas/AbortDate' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) - 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.' - AbortRuleId: - $ref: '#/components/schemas/AbortRuleId' - description: '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.' - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload was initiated. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: ID for the initiated multipart upload. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: If present, indicates the Amazon Web Services KMS Encryption - Context to use for object encryption. The value of this header is a Base64 - encoded string of a UTF-8 encoded JSON, which contains the encryption - context as key-value pairs. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the multipart upload uses an S3 Bucket Key - for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The algorithm that was used to create a checksum of the object. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: Indicates the checksum type that you want Amazon S3 to use - to calculate the object’s checksum value. For more information, see [Checking - object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - CreateMultipartUploadRequest: - type: object - properties: - ACL: - $ref: '#/components/schemas/ObjectCannedACL' - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL)\ - \ in the _Amazon S3 User Guide_.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).\ - \ One way to grant the permissions using the request headers is to specify\ - \ a canned ACL with the `x-amz-acl` request header.\n\n * This functionality\ - \ is not supported for directory buckets.\n\n * This functionality is\ - \ not supported for Amazon S3 on Outposts." - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - CacheControl: - $ref: '#/components/schemas/CacheControl' - description: Specifies caching behavior along the request/reply chain. - ContentDisposition: - $ref: '#/components/schemas/ContentDisposition' - description: Specifies presentational information for the object. - ContentEncoding: - $ref: '#/components/schemas/ContentEncoding' - description: '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.' - ContentLanguage: - $ref: '#/components/schemas/ContentLanguage' - description: The language that the content is in. - ContentType: - $ref: '#/components/schemas/ContentType' - description: A standard MIME type describing the format of the object data. - Expires: - $ref: '#/components/schemas/Expires' - description: The date and time at which the object is no longer cacheable. - GrantFullControl: - $ref: '#/components/schemas/GrantFullControl' - description: "Specify access permissions explicitly to give the grantee\ - \ READ, READ_ACP, and WRITE_ACP permissions on the object.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ - \ pair, where the type is one of the following:\n\n * `id` – if the value\ - \ specified is the canonical user ID of an Amazon Web Services account\n\ - \n * `uri` – if you are granting permissions to a predefined group\n\n\ - \ * `emailAddress` – if the value specified is the email address of an\ - \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ - \ is only supported in the following Amazon Web Services Regions:\n\n\ - \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ - \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ - \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ - \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ - \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ - `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ - \ functionality is not supported for directory buckets.\n\n * This functionality\ - \ is not supported for Amazon S3 on Outposts." - GrantRead: - $ref: '#/components/schemas/GrantRead' - description: "Specify access permissions explicitly to allow grantee to\ - \ read the object data and its metadata.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ - \ pair, where the type is one of the following:\n\n * `id` – if the value\ - \ specified is the canonical user ID of an Amazon Web Services account\n\ - \n * `uri` – if you are granting permissions to a predefined group\n\n\ - \ * `emailAddress` – if the value specified is the email address of an\ - \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ - \ is only supported in the following Amazon Web Services Regions:\n\n\ - \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ - \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ - \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ - \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ - \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ - `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ - \ functionality is not supported for directory buckets.\n\n * This functionality\ - \ is not supported for Amazon S3 on Outposts." - GrantReadACP: - $ref: '#/components/schemas/GrantReadACP' - description: "Specify access permissions explicitly to allows grantee to\ - \ read the object ACL.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ - \ pair, where the type is one of the following:\n\n * `id` – if the value\ - \ specified is the canonical user ID of an Amazon Web Services account\n\ - \n * `uri` – if you are granting permissions to a predefined group\n\n\ - \ * `emailAddress` – if the value specified is the email address of an\ - \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ - \ is only supported in the following Amazon Web Services Regions:\n\n\ - \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ - \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ - \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ - \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ - \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ - `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ - \ functionality is not supported for directory buckets.\n\n * This functionality\ - \ is not supported for Amazon S3 on Outposts." - GrantWriteACP: - $ref: '#/components/schemas/GrantWriteACP' - description: "Specify access permissions explicitly to allows grantee to\ - \ allow grantee to write the ACL for the applicable object.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ - \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ - \ pair, where the type is one of the following:\n\n * `id` – if the value\ - \ specified is the canonical user ID of an Amazon Web Services account\n\ - \n * `uri` – if you are granting permissions to a predefined group\n\n\ - \ * `emailAddress` – if the value specified is the email address of an\ - \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ - \ is only supported in the following Amazon Web Services Regions:\n\n\ - \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ - \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ - \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ - \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ - \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ - \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ - `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ - \ functionality is not supported for directory buckets.\n\n * This functionality\ - \ is not supported for Amazon S3 on Outposts." - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload is to be initiated. - Metadata: - $ref: '#/components/schemas/Metadata' - description: A map of metadata to store with the object in S3. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: "The server-side encryption algorithm used when you store this\ - \ object in Amazon S3 or Amazon FSx.\n\n * **Directory buckets** \\-\ - \ For directory buckets, there are only two supported options for server-side\ - \ encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)\ - \ (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).\ - \ We recommend that the bucket's default encryption uses the desired encryption\ - \ configuration and you don't override the bucket default encryption in\ - \ your `CreateSession` requests or `PUT` object requests. Then, new objects\ - \ are automatically encrypted with the desired encryption settings. For\ - \ more information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_. For more information about the encryption\ - \ overriding behaviors in directory buckets, see [Specifying server-side\ - \ encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\ - \ \n\nIn the Zonal endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))\ - \ using the REST API, the encryption request headers must match the encryption\ - \ settings that are specified in the `CreateSession` request. You can't\ - \ override the values of the encryption settings (`x-amz-server-side-encryption`,\ - \ `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`,\ - \ and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified\ - \ in the `CreateSession` request. You don't need to explicitly specify\ - \ these encryption settings values in Zonal endpoint API calls, and Amazon\ - \ S3 will use the encryption settings values from the `CreateSession`\ - \ request to protect new objects in the directory bucket.\n\nWhen you\ - \ use the CLI or the Amazon Web Services SDKs, for `CreateSession`, the\ - \ session token refreshes automatically to avoid service interruptions\ - \ when a session expires. The CLI or the Amazon Web Services SDKs use\ - \ the bucket's default encryption configuration for the `CreateSession`\ - \ request. It's not supported to override the encryption settings values\ - \ in the `CreateSession` request. So in the Zonal endpoint API calls (except\ - \ [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),\ - \ the encryption request headers must match the default encryption configuration\ - \ of the directory bucket.\n\n * **S3 access points for Amazon FSx**\ - \ \\- When accessing data stored in Amazon FSx file systems using S3 access\ - \ points, the only valid server side encryption option is `aws:fsx`. All\ - \ Amazon FSx file systems have encryption configured by default and are\ - \ encrypted at rest. Data is automatically encrypted before being written\ - \ to the file system, and automatically decrypted as it is read. These\ - \ processes are handled transparently by Amazon FSx." - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)\ - \ in the _Amazon S3 User Guide_.\n\n * Directory buckets only support\ - \ `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability\ - \ Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class)\ - \ in Dedicated Local Zones.\n\n * Amazon S3 on Outposts only uses the\ - \ OUTPOSTS Storage Class." - WebsiteRedirectLocation: - $ref: '#/components/schemas/WebsiteRedirectLocation' - description: '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.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: 'Specifies the algorithm to use when encrypting the object - (for example, AES256). - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: 'Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to - use for object encryption. If the KMS key doesn''t exist in the same account - that''s issuing the command, you must use the full Key ARN not the Key - ID. - - - **General purpose buckets** \- If you specify `x-amz-server-side-encryption` - with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, - Key ARN, or Key Alias) of the KMS key to use. 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. - - - **Directory buckets** \- To encrypt data using SSE-KMS, it''s recommended - to specify the `x-amz-server-side-encryption` header to `aws:kms`. Then, - the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses - the bucket''s default KMS customer managed key ID. If you want to explicitly - set the ` x-amz-server-side-encryption-aws-kms-key-id` header, it must - match the bucket''s default customer managed key (using key ID or ARN, - not alias). Your SSE-KMS configuration can only support 1 [customer managed - key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) - per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) - (`aws/s3`) isn''t supported. Incorrect key specification results in an - HTTP `400 Bad Request` error.' - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: 'Specifies the Amazon Web Services KMS Encryption Context to - use for object encryption. The value of this header is a Base64 encoded - string of a UTF-8 encoded JSON, which contains the encryption context - as key-value pairs. - - - **Directory buckets** \- You can optionally provide an explicit encryption - context value. The value must match the default encryption context - the - bucket Amazon Resource Name (ARN). An additional encryption context value - is not supported.' - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: '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). - - - **General purpose buckets** \- Setting this header to `true` causes Amazon - S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying - this header with a PUT action doesn''t affect bucket-level settings for - S3 Bucket Key. - - - **Directory buckets** \- S3 Bucket Keys are always enabled for `GET` and - `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket - Keys aren''t supported, when you copy SSE-KMS encrypted objects from general - purpose buckets to directory buckets, from directory buckets to general - purpose buckets, or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), - [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), - [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), - or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). - In this case, Amazon S3 makes a call to KMS every time a copy request - is made for a KMS-encrypted object.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - Tagging: - $ref: '#/components/schemas/TaggingHeader' - description: 'The tag-set for the object. The tag-set must be encoded as - URL Query parameters. - - - This functionality is not supported for directory buckets.' - ObjectLockMode: - $ref: '#/components/schemas/ObjectLockMode' - description: 'Specifies the Object Lock mode that you want to apply to the - uploaded object. - - - This functionality is not supported for directory buckets.' - ObjectLockRetainUntilDate: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - description: 'Specifies the date and time when you want the Object Lock - to expire. - - - This functionality is not supported for directory buckets.' - ObjectLockLegalHoldStatus: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: 'Specifies whether you want to apply a legal hold to the uploaded - object. - - - This functionality is not supported for directory buckets.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: Indicates the algorithm that you want Amazon S3 to use to create - the checksum for the object. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: Indicates the checksum type that you want Amazon S3 to use - to calculate the object’s checksum value. For more information, see [Checking - object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - required: - - Bucket - - Key - CreateSessionOutput: - type: object - properties: - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store objects - in the directory bucket. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If you specify `x-amz-server-side-encryption` with `aws:kms`, - this header indicates the ID of the KMS symmetric encryption customer - managed key that was used for object encryption. - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: If present, indicates the Amazon Web Services KMS Encryption - Context to use for object encryption. The value of this header is a Base64 - encoded string of a UTF-8 encoded JSON, which contains the encryption - context as key-value pairs. This value is stored as object metadata and - automatically gets passed on to Amazon Web Services KMS for future `GetObject` - operations on this object. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether to use an S3 Bucket Key for server-side encryption - with KMS keys (SSE-KMS). - Credentials: - $ref: '#/components/schemas/SessionCredentials' - description: The established temporary security credentials for the created - session. - required: - - Credentials - CreateSessionRequest: - type: object - properties: - SessionMode: - $ref: '#/components/schemas/SessionMode' - description: '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 API - operations on a directory bucket. A `ReadOnly` session is constrained - to execute the following Zonal endpoint API operations: `GetObject`, `HeadObject`, - `ListObjectsV2`, `GetObjectAttributes`, `ListParts`, and `ListMultipartUploads`.' - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket that you create a session for. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm to use when you store - objects in the directory bucket. - - - For directory buckets, there are only two supported options for server-side - encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) - (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). - By default, Amazon S3 encrypts data with SSE-S3. For more information, - see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html) - in the _Amazon S3 User Guide_. - - - **S3 access points for Amazon FSx** \- When accessing data stored in Amazon - FSx file systems using S3 access points, the only valid server side encryption - option is `aws:fsx`. All Amazon FSx file systems have encryption configured - by default and are encrypted at rest. Data is automatically encrypted - before being written to the file system, and automatically decrypted as - it is read. These processes are handled transparently by Amazon FSx.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: 'If you specify `x-amz-server-side-encryption` with `aws:kms`, - you must specify the ` x-amz-server-side-encryption-aws-kms-key-id` header - with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer - managed key to use. Otherwise, you get an HTTP `400 Bad Request` error. - Only use the key ID or key ARN. The key alias format of the KMS key isn''t - supported. Also, if the KMS key doesn''t exist in the same account that''t - issuing the command, you must use the full Key ARN not the Key ID. - - - Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) - per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) - (`aws/s3`) isn''t supported.' - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: 'Specifies the Amazon Web Services KMS Encryption Context as - an additional encryption context to use for object encryption. The value - of this header is a Base64 encoded string of a UTF-8 encoded JSON, which - contains the encryption context as key-value pairs. This value is stored - as object metadata and automatically gets passed on to Amazon Web Services - KMS for future `GetObject` operations on this object. - - - **General purpose buckets** \- This value must be explicitly added during - `CopyObject` operations if you want an additional encryption context for - your object. For more information, see [Encryption context](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context) - in the _Amazon S3 User Guide_. - - - **Directory buckets** \- You can optionally provide an explicit encryption - context value. The value must match the default encryption context - the - bucket Amazon Resource Name (ARN). An additional encryption context value - is not supported.' - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: 'Specifies whether Amazon S3 should use an S3 Bucket Key for - object encryption with server-side encryption using KMS keys (SSE-KMS). - - - S3 Bucket Keys are always enabled for `GET` and `PUT` operations in a - directory bucket and can’t be disabled. S3 Bucket Keys aren''t supported, - when you copy SSE-KMS encrypted objects from general purpose buckets to - directory buckets, from directory buckets to general purpose buckets, - or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), - [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), - [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), - or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). - In this case, Amazon S3 makes a call to KMS every time a copy request - is made for a KMS-encrypted object.' - required: - - Bucket - CreationDate: - type: string - format: date-time - DataRedundancy: - type: string - enum: - - SingleAvailabilityZone - - SingleLocalZone - Date: - type: string - format: date-time - Days: - type: integer - DaysAfterInitiation: - type: integer - DefaultRetention: - type: object - properties: - Mode: - $ref: '#/components/schemas/ObjectLockRetentionMode' - description: The default Object Lock retention mode you want to apply to - new objects placed in the specified bucket. Must be used with either `Days` - or `Years`. - Days: - $ref: '#/components/schemas/Days' - description: The number of days that you want to specify for the default - retention period. Must be used with `Mode`. - Years: - $ref: '#/components/schemas/Years' - description: The number of years that you want to specify for the default - retention period. Must be used with `Mode`. - description: "The container element for optionally specifying the default Object\ - \ Lock retention settings for new objects placed in the specified bucket.\n\ - \n * The `DefaultRetention` settings require both a mode and a period.\n\n\ - \ * The `DefaultRetention` period can be either `Days` or `Years` but you\ - \ must select one. You cannot specify `Days` and `Years` at the same time." - Delete: - type: object - properties: - Objects: - $ref: '#/components/schemas/ObjectIdentifierList' - description: '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.' - Quiet: - $ref: '#/components/schemas/Quiet' - description: Element to enable quiet mode for the request. When you add - this element, you must set its value to `true`. - required: - - Objects - description: Container for the objects to delete. - DeleteBucketAnalyticsConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket from which an analytics configuration - is deleted. - Id: - $ref: '#/components/schemas/AnalyticsId' - description: The ID that identifies the analytics configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - DeleteBucketCorsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: Specifies the bucket whose `cors` configuration is being deleted. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - DeleteBucketEncryptionRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The name of the bucket containing the server-side encryption - configuration to delete. - - - **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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - DeleteBucketIntelligentTieringConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose configuration you want - to modify or retrieve. - Id: - $ref: '#/components/schemas/IntelligentTieringId' - description: The ID used to identify the S3 Intelligent-Tiering configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - DeleteBucketInventoryConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the inventory configuration - to delete. - Id: - $ref: '#/components/schemas/InventoryId' - description: The ID used to identify the inventory configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - DeleteBucketLifecycleRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name of the lifecycle to delete. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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). - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - required: - - Bucket - DeleteBucketMetadataConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that you want to remove the metadata - configuration from. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected bucket owner of the general purpose bucket that - you want to remove the metadata table configuration from. - required: - - Bucket - DeleteBucketMetadataTableConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that you want to remove the metadata - table configuration from. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected bucket owner of the general purpose bucket that - you want to remove the metadata table configuration from. - required: - - Bucket - DeleteBucketMetricsConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the metrics configuration - to delete. - Id: - $ref: '#/components/schemas/MetricsId' - description: The ID used to identify the metrics configuration. The ID has - a 64 character limit and can only contain letters, numbers, periods, dashes, - and underscores. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - DeleteBucketOwnershipControlsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The Amazon S3 bucket whose `OwnershipControls` you want to - delete. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - DeleteBucketPolicyRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - DeleteBucketReplicationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - DeleteBucketRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - DeleteBucketTaggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket that has the tag set to be removed. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - DeleteBucketWebsiteRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name for which you want to remove the website configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - DeleteMarker: - type: boolean - DeleteMarkerEntry: - type: object - properties: - Owner: - $ref: '#/components/schemas/Owner' - description: The account that created the delete marker. - Key: - $ref: '#/components/schemas/ObjectKey' - description: The object key. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: Version ID of an object. - IsLatest: - $ref: '#/components/schemas/IsLatest' - description: Specifies whether the object is (true) or is not (false) the - latest version of an object. - LastModified: - $ref: '#/components/schemas/LastModified' - description: Date and time when the object was last modified. - description: Information about the delete marker. - DeleteMarkerReplication: - type: object - properties: - Status: - $ref: '#/components/schemas/DeleteMarkerReplicationStatus' - description: 'Indicates whether to replicate delete markers. - - - Indicates whether to replicate delete markers.' - description: 'Specifies whether Amazon S3 replicates delete markers. If you - specify a `Filter` in your replication configuration, you must also include - a `DeleteMarkerReplication` element. If your `Filter` includes a `Tag` element, - the `DeleteMarkerReplication` `Status` must be set to Disabled, because Amazon - S3 does not support replicating delete markers for tag-based rules. For an - example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). - - - For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). - - - 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).' - DeleteMarkerReplicationStatus: - type: string - enum: - - Enabled - - Disabled - DeleteMarkerVersionId: - type: string - DeleteMarkers: - type: array - items: - $ref: '#/components/schemas/DeleteMarkerEntry' - DeleteObjectOutput: - type: object - properties: - DeleteMarker: - $ref: '#/components/schemas/DeleteMarker' - description: '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. To learn more about - delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). - - - This functionality is not supported for directory buckets.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Returns the version ID of the delete marker created as a result - of the DELETE operation. - - - This functionality is not supported for directory buckets.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - DeleteObjectRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Key name of the object to delete. - MFA: - $ref: '#/components/schemas/MFA' - description: '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.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - BypassGovernanceRetention: - $ref: '#/components/schemas/BypassGovernanceRetention' - description: '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.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - IfMatch: - $ref: '#/components/schemas/IfMatch' - description: 'Deletes the object if the ETag (entity tag) value provided - during the delete operation matches the ETag of the object in S3. If the - ETag values do not match, the operation returns a `412 Precondition Failed` - error. - - - Expects the ETag value as a string. `If-Match` does accept a string value - of an ''*'' (asterisk) character to denote a match of any ETag. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).' - IfMatchLastModifiedTime: - $ref: '#/components/schemas/IfMatchLastModifiedTime' - description: 'If present, the object is deleted only if its modification - times matches the provided `Timestamp`. If the `Timestamp` values do not - match, the operation returns a `412 Precondition Failed` error. If the - `Timestamp` matches or if the object doesn’t exist, the operation returns - a `204 Success (No Content)` response. - - - This functionality is only supported for directory buckets.' - IfMatchSize: - $ref: '#/components/schemas/IfMatchSize' - description: 'If present, the object is deleted only if its size matches - the provided size in bytes. If the `Size` value does not match, the operation - returns a `412 Precondition Failed` error. If the `Size` matches or if - the object doesn’t exist, the operation returns a `204 Success (No Content)` - response. - - - This functionality is only supported for directory buckets. - - - You can use the `If-Match`, `x-amz-if-match-last-modified-time` and `x-amz-if-match-size` - conditional headers in conjunction with each-other or individually.' - required: - - Bucket - - Key - DeleteObjectTaggingOutput: - type: object - properties: - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The versionId of the object the tag-set was removed from. - DeleteObjectTaggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket name containing the objects from which to remove - the tags. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key that identifies the object in the bucket from which - to remove all tags. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The versionId of the object that the tag-set will be removed - from. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - DeleteObjectsOutput: - type: object - properties: - Deleted: - $ref: '#/components/schemas/DeletedObjects' - description: Container element for a successful delete. It identifies the - object that was successfully deleted. - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - Errors: - $ref: '#/components/schemas/Errors' - description: Container for a failed delete action that describes the object - that Amazon S3 attempted to delete and the error it encountered. - DeleteObjectsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Delete: - $ref: '#/components/schemas/Delete' - description: Container for the request. - MFA: - $ref: '#/components/schemas/MFA' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - BypassGovernanceRetention: - $ref: '#/components/schemas/BypassGovernanceRetention' - description: '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.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: "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`.\n\nFor the `x-amz-checksum-_algorithm_ ` header,\ - \ replace ` _algorithm_ ` with the supported algorithm from the following\ - \ list:\n\n * `CRC32`\n\n * `CRC32C`\n\n * `CRC64NVME`\n\n * `SHA1`\n\ - \n * `SHA256`\n\nFor more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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\ - \ fails the request with a `BadDigest` error.\n\nIf you provide an individual\ - \ checksum, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter." - required: - - Bucket - - Delete - DeletePublicAccessBlockRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The Amazon S3 bucket whose `PublicAccessBlock` configuration - you want to delete. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - DeletedObject: - type: object - properties: - Key: - $ref: '#/components/schemas/ObjectKey' - description: The name of the deleted object. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'The version ID of the deleted object. - - - This functionality is not supported for directory buckets.' - DeleteMarker: - $ref: '#/components/schemas/DeleteMarker' - description: '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. To learn more about - delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). - - - This functionality is not supported for directory buckets.' - DeleteMarkerVersionId: - $ref: '#/components/schemas/DeleteMarkerVersionId' - description: '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.' - description: Information about the deleted object. - DeletedObjects: - type: array - items: - $ref: '#/components/schemas/DeletedObject' - Delimiter: - type: string - Description: - type: string - Destination: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The Amazon Resource Name (ARN) of the bucket where you want - Amazon S3 to store the results. - Account: - $ref: '#/components/schemas/AccountId' - description: 'Destination bucket owner account ID. In a cross-account scenario, - if you direct Amazon S3 to change replica ownership to the Amazon Web - Services account that owns the destination bucket by specifying the `AccessControlTranslation` - property, this is the account ID of the destination bucket owner. For - more information, see [Replication Additional Configuration: Changing - the Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html) - in the _Amazon S3 User Guide_.' - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: 'The storage class to use when replicating objects, such as - S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage - class of the source object to create the object replica. - - - For valid values, see the `StorageClass` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) - action in the _Amazon S3 API Reference_. - - - `FSX_OPENZFS` is not an accepted value when replicating objects.' - AccessControlTranslation: - $ref: '#/components/schemas/AccessControlTranslation' - description: Specify this only in a cross-account scenario (where source - and destination bucket owners are not the same), and you want to change - replica ownership to the Amazon Web Services account that owns the destination - bucket. If this is not specified in the replication configuration, the - replicas are owned by same Amazon Web Services account that owns the source - object. - EncryptionConfiguration: - $ref: '#/components/schemas/EncryptionConfiguration' - description: A container that provides information about encryption. If - `SourceSelectionCriteria` is specified, you must specify this element. - ReplicationTime: - $ref: '#/components/schemas/ReplicationTime' - description: A container specifying S3 Replication Time Control (S3 RTC), - including whether S3 RTC is enabled and the time when all objects and - operations on objects must be replicated. Must be specified together with - a `Metrics` block. - Metrics: - $ref: '#/components/schemas/Metrics' - description: A container specifying replication metrics-related settings - enabling replication metrics and events. - required: - - Bucket - description: Specifies information about where to publish analysis or configuration - results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). - DestinationResult: - type: object - properties: - TableBucketType: - $ref: '#/components/schemas/S3TablesBucketType' - description: The type of the table bucket where the metadata configuration - is stored. The `aws` value indicates an Amazon Web Services managed table - bucket, and the `customer` value indicates a customer-managed table bucket. - V2 metadata configurations are stored in Amazon Web Services managed table - buckets, and V1 metadata configurations are stored in customer-managed - table buckets. - TableBucketArn: - $ref: '#/components/schemas/S3TablesBucketArn' - description: The Amazon Resource Name (ARN) of the table bucket where the - metadata configuration is stored. - TableNamespace: - $ref: '#/components/schemas/S3TablesNamespace' - description: The namespace in the table bucket where the metadata tables - for a metadata configuration are stored. - description: The destination information for the S3 Metadata configuration. - DirectoryBucketToken: - type: string - minLength: 0 - maxLength: 1024 - DisplayName: - type: string - ETag: - type: string - EmailAddress: - type: string - EnableRequestProgress: - type: boolean - EncodingType: - type: string - enum: - - url - description: "

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are\n encoded only in UTF-8.\ - \ An object key can contain any Unicode character. However, the XML 1.0 parser\n\ - \ can't parse certain characters, such as characters with an ASCII value\ - \ from 0 to 10. For characters that\n aren't supported in XML 1.0, you\ - \ can add this parameter to request that Amazon S3 encode the keys in the\n\ - \ response. For more information about characters to avoid in object\ - \ key names, see Object key\n naming guidelines.

\n \n \ - \

When using the URL encoding type, non-ASCII characters that are used\ - \ in an object's key name will\n be percent-encoded according to UTF-8\ - \ code values. For example, the object\n test_file(3).png\ - \ will appear as test_file%283%29.png.

\n " - Encryption: - type: object - properties: - EncryptionType: - $ref: '#/components/schemas/ServerSideEncryption' - description: The server-side encryption algorithm used when storing job - results in Amazon S3 (for example, AES256, `aws:kms`). - KMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If the encryption type is `aws:kms`, this optional value specifies - the ID of the symmetric encryption customer managed key to use for encryption - of job results. Amazon S3 only supports symmetric encryption KMS keys. - For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) - in the _Amazon Web Services Key Management Service Developer Guide_. - KMSContext: - $ref: '#/components/schemas/KMSContext' - description: If the encryption type is `aws:kms`, this optional value can - be used to specify the encryption context for the restore results. - required: - - EncryptionType - description: Contains the type of server-side encryption used. - EncryptionConfiguration: - type: object - properties: - ReplicaKmsKeyID: - $ref: '#/components/schemas/ReplicaKmsKeyID' - description: Specifies the ID (Key ARN or Alias ARN) of the customer managed - Amazon Web Services KMS key stored in Amazon Web Services Key Management - Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt - replica objects. Amazon S3 only supports symmetric encryption KMS keys. - For more information, see [Asymmetric keys in Amazon Web Services KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) - in the _Amazon Web Services Key Management Service Developer Guide_. - description: 'Specifies encryption-related information for an Amazon S3 bucket - that is a destination for replicated objects. - - - If you''re specifying a customer managed KMS key, we recommend using a fully - qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves - the key within the requester’s account. This behavior can result in data that''s - encrypted with a KMS key that belongs to the requester, and not the bucket - owner.' - EncryptionType: - type: string - enum: - - NONE - - SSE-C - EncryptionTypeList: - type: array - items: - $ref: '#/components/schemas/EncryptionType' - EncryptionTypeMismatch: - type: object - properties: {} - description: The existing object was created with a different encryption type. - Subsequent write requests must include the appropriate encryption parameters - in the request or while creating the session. - End: - type: integer - format: int64 - EndEvent: - type: object - properties: {} - description: A message that indicates the request is complete and no more messages - will be sent. You should not assume that the request is complete until the - client receives an `EndEvent`. - Error: - type: object - properties: - Key: - $ref: '#/components/schemas/ObjectKey' - description: The error key. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'The version ID of the error. - - - This functionality is not supported for directory buckets.' - Code: - $ref: '#/components/schemas/Code' - description: "The error code is a string that uniquely identifies an error\ - \ condition. It is meant to be read and understood by programs that detect\ - \ and handle errors by type. The following is a list of Amazon S3 error\ - \ codes. For more information, see [Error responses](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html).\n\ - \n * * _Code:_ AccessDenied \n\n * _Description:_ Access Denied\n\ - \n * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ AccountProblem\n\n * _Description:_ There\ - \ is a problem with your Amazon Web Services account that prevents the\ - \ action from completing successfully. Contact Amazon Web Services Support\ - \ for further assistance.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ AllAccessDisabled\n\ - \n * _Description:_ All access to this Amazon S3 resource has been\ - \ disabled. Contact Amazon Web Services Support for further assistance.\n\ - \n * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ AmbiguousGrantByEmailAddress\n\n * _Description:_\ - \ The email address you provided is associated with more than one account.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ AuthorizationHeaderMalformed\n\n\ - \ * _Description:_ The authorization header you provided is invalid.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _HTTP Status Code:_\ - \ N/A\n\n * * _Code:_ BadDigest\n\n * _Description:_ The Content-MD5\ - \ you specified did not match what we received.\n\n * _HTTP Status\ - \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ - \ * * _Code:_ BucketAlreadyExists\n\n * _Description:_ The requested\ - \ bucket name is not available. The bucket namespace is shared by all\ - \ users of the system. Please select a different name and try again.\n\ - \n * _HTTP Status Code:_ 409 Conflict\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ BucketAlreadyOwnedByYou\n\n * _Description:_\ - \ 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).\n\ - \n * _Code:_ 409 Conflict (in all Regions except the North Virginia\ - \ Region) \n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ BucketNotEmpty\n\n * _Description:_ The bucket you tried to delete\ - \ is not empty.\n\n * _HTTP Status Code:_ 409 Conflict\n\n * _SOAP\ - \ Fault Code Prefix:_ Client\n\n * * _Code:_ CredentialsNotSupported\n\ - \n * _Description:_ This request does not support credentials.\n\n\ - \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ CrossLocationLoggingProhibited\n\n *\ - \ _Description:_ Cross-location logging not allowed. Buckets in one geographic\ - \ location cannot log information to a bucket in another location.\n\n\ - \ * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ EntityTooSmall\n\n * _Description:_ Your\ - \ proposed upload is smaller than the minimum allowed object size.\n\n\ - \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ EntityTooLarge\n\n * _Description:_ Your\ - \ proposed upload exceeds the maximum allowed object size.\n\n * _HTTP\ - \ Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\ - \n * * _Code:_ ExpiredToken\n\n * _Description:_ The provided\ - \ token has expired.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ IllegalVersioningConfigurationException\ - \ \n\n * _Description:_ Indicates that the versioning configuration\ - \ specified in the request is invalid.\n\n * _HTTP Status Code:_ 400\ - \ Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ IncompleteBody\n\n * _Description:_ You did not provide the number\ - \ of bytes specified by the Content-Length HTTP header\n\n * _HTTP\ - \ Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\ - \n * * _Code:_ IncorrectNumberOfFilesInPostRequest\n\n * _Description:_\ - \ POST requires exactly one file upload per request.\n\n * _HTTP Status\ - \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ - \ * * _Code:_ InlineDataTooLarge\n\n * _Description:_ Inline data\ - \ exceeds the maximum allowed size.\n\n * _HTTP Status Code:_ 400 Bad\ - \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ InternalError\n\n * _Description:_ We encountered an internal error.\ - \ Please try again.\n\n * _HTTP Status Code:_ 500 Internal Server Error\n\ - \n * _SOAP Fault Code Prefix:_ Server\n\n * * _Code:_ InvalidAccessKeyId\n\ - \n * _Description:_ The Amazon Web Services access key ID you provided\ - \ does not exist in our records.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidAddressingHeader\n\ - \n * _Description:_ You must specify the Anonymous role.\n\n * _HTTP\ - \ Status Code:_ N/A\n\n * _SOAP Fault Code Prefix:_ Client\n\n * \ - \ * _Code:_ InvalidArgument\n\n * _Description:_ Invalid Argument\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ InvalidBucketName\n\n * _Description:_\ - \ The specified bucket is not valid.\n\n * _HTTP Status Code:_ 400\ - \ Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ InvalidBucketState\n\n * _Description:_ The request is not valid\ - \ with the current state of the bucket.\n\n * _HTTP Status Code:_ 409\ - \ Conflict\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ InvalidDigest\n\n * _Description:_ The Content-MD5 you specified\ - \ is not valid.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n *\ - \ _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidEncryptionAlgorithmError\n\ - \n * _Description:_ The encryption request you specified is not valid.\ - \ The valid value is AES256.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidLocationConstraint\n\ - \n * _Description:_ The specified location constraint is not valid.\ - \ For more information about Regions, see [How to Select a Region for\ - \ Your Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).\ - \ \n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ InvalidObjectState\n\n * _Description:_\ - \ The action is not valid for the current state of the object.\n\n \ - \ * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ InvalidPart\n\n * _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.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidPartOrder\n\ - \n * _Description:_ The list of parts was not in ascending order. Parts\ - \ list must be specified in order by part number.\n\n * _HTTP Status\ - \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ - \ * * _Code:_ InvalidPayer\n\n * _Description:_ All access to\ - \ this object has been disabled. Please contact Amazon Web Services Support\ - \ for further assistance.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidPolicyDocument\n\ - \n * _Description:_ The content of the form does not meet the conditions\ - \ specified in the policy document.\n\n * _HTTP Status Code:_ 400 Bad\ - \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ InvalidRange\n\n * _Description:_ The requested range cannot be satisfied.\n\ - \n * _HTTP Status Code:_ 416 Requested Range Not Satisfiable\n\n \ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidRequest\n\ - \n * _Description:_ Please use `AWS4-HMAC-SHA256`.\n\n * _HTTP Status\ - \ Code:_ 400 Bad Request\n\n * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\ - \n * _Description:_ SOAP requests must be made over an HTTPS connection.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ InvalidRequest\n\n * _Description:_\ - \ Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS\ - \ compliant names.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n \ - \ * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\n * _Description:_\ - \ Amazon S3 Transfer Acceleration is not supported for buckets with periods\ - \ (.) in their names.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\n * _Description:_\ - \ Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _Code:_ N/A\n\n \ - \ * * _Code:_ InvalidRequest\n\n * _Description:_ Amazon S3 Transfer\ - \ Accelerate is not configured on this bucket.\n\n * _HTTP Status Code:_\ - \ 400 Bad Request\n\n * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\ - \n * _Description:_ Amazon S3 Transfer Accelerate is disabled on this\ - \ bucket.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _Code:_\ - \ N/A\n\n * * _Code:_ InvalidRequest\n\n * _Description:_ Amazon\ - \ S3 Transfer Acceleration is not supported on this bucket. Contact Amazon\ - \ Web Services Support for more information.\n\n * _HTTP Status Code:_\ - \ 400 Bad Request\n\n * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\ - \n * _Description:_ Amazon S3 Transfer Acceleration cannot be enabled\ - \ on this bucket. Contact Amazon Web Services Support for more information.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _Code:_ N/A\n\n \ - \ * * _Code:_ InvalidSecurity\n\n * _Description:_ The provided\ - \ security credentials are not valid.\n\n * _HTTP Status Code:_ 403\ - \ Forbidden\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ InvalidSOAPRequest\n\n * _Description:_ The SOAP request body is\ - \ invalid.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ - \ Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidStorageClass\n\ - \n * _Description:_ The storage class you specified is not valid.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ InvalidTargetBucketForLogging\n\ - \n * _Description:_ The target bucket for logging does not exist, is\ - \ not owned by you, or does not have the appropriate grants for the log-delivery\ - \ group. \n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ - \ Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidToken\n\n \ - \ * _Description:_ The provided token is malformed or otherwise invalid.\n\ - \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ InvalidURI\n\n * _Description:_\ - \ Couldn't parse the specified URI.\n\n * _HTTP Status Code:_ 400 Bad\ - \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ KeyTooLongError\n\n * _Description:_ Your key is too long.\n\n \ - \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ MalformedACLError\n\n * _Description:_\ - \ The XML you provided was not well-formed or did not validate against\ - \ our published schema.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MalformedPOSTRequest\ - \ \n\n * _Description:_ The body of your POST request is not well-formed\ - \ multipart/form-data.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MalformedXML\n\ - \n * _Description:_ This happens when the user sends malformed XML\ - \ (XML that doesn't conform to the published XSD) for the configuration.\ - \ The error message is, \"The XML you provided was not well-formed or\ - \ did not validate against our published schema.\" \n\n * _HTTP Status\ - \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ - \ * * _Code:_ MaxMessageLengthExceeded\n\n * _Description:_ Your\ - \ request was too big.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MaxPostPreDataLengthExceededError\n\ - \n * _Description:_ Your POST request fields preceding the upload file\ - \ were too large.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n \ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MetadataTooLarge\n\ - \n * _Description:_ Your metadata headers exceed the maximum allowed\ - \ metadata size.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n *\ - \ _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MethodNotAllowed\n\ - \n * _Description:_ The specified method is not allowed against this\ - \ resource.\n\n * _HTTP Status Code:_ 405 Method Not Allowed\n\n \ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MissingAttachment\n\ - \n * _Description:_ A SOAP attachment was expected, but none were found.\n\ - \n * _HTTP Status Code:_ N/A\n\n * _SOAP Fault Code Prefix:_ Client\n\ - \n * * _Code:_ MissingContentLength\n\n * _Description:_ You must\ - \ provide the Content-Length HTTP header.\n\n * _HTTP Status Code:_\ - \ 411 Length Required\n\n * _SOAP Fault Code Prefix:_ Client\n\n *\ - \ * _Code:_ MissingRequestBodyError\n\n * _Description:_ This happens\ - \ when the user sends an empty XML document as a request. The error message\ - \ is, \"Request body is empty.\" \n\n * _HTTP Status Code:_ 400 Bad\ - \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ MissingSecurityElement\n\n * _Description:_ The SOAP 1.1 request\ - \ is missing a security element.\n\n * _HTTP Status Code:_ 400 Bad\ - \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ MissingSecurityHeader\n\n * _Description:_ Your request is missing\ - \ a required header.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ NoLoggingStatusForKey\n\ - \n * _Description:_ There is no such thing as a logging status subresource\ - \ for a key.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ - \ Fault Code Prefix:_ Client\n\n * * _Code:_ NoSuchBucket\n\n \ - \ * _Description:_ The specified bucket does not exist.\n\n * _HTTP\ - \ Status Code:_ 404 Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\ - \n * * _Code:_ NoSuchBucketPolicy\n\n * _Description:_ The specified\ - \ bucket does not have a bucket policy.\n\n * _HTTP Status Code:_ 404\ - \ Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ NoSuchKey\n\n * _Description:_ The specified key does not exist.\n\ - \n * _HTTP Status Code:_ 404 Not Found\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ NoSuchLifecycleConfiguration\n\n * _Description:_\ - \ The lifecycle configuration does not exist. \n\n * _HTTP Status Code:_\ - \ 404 Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\n * *\ - \ _Code:_ NoSuchUpload\n\n * _Description:_ The specified multipart\ - \ upload does not exist. The upload ID might be invalid, or the multipart\ - \ upload might have been aborted or completed.\n\n * _HTTP Status Code:_\ - \ 404 Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\n * *\ - \ _Code:_ NoSuchVersion \n\n * _Description:_ Indicates that the version\ - \ ID specified in the request does not match an existing version.\n\n\ - \ * _HTTP Status Code:_ 404 Not Found\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ NotImplemented\n\n * _Description:_ A\ - \ header you provided implies functionality that is not implemented.\n\ - \n * _HTTP Status Code:_ 501 Not Implemented\n\n * _SOAP Fault Code\ - \ Prefix:_ Server\n\n * * _Code:_ NotSignedUp\n\n * _Description:_\ - \ Your account is not signed up for the Amazon S3 service. You must sign\ - \ up before you can use Amazon S3. You can sign up at the following URL:\ - \ [Amazon S3](http://aws.amazon.com/s3)\n\n * _HTTP Status Code:_ 403\ - \ Forbidden\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ - \ OperationAborted\n\n * _Description:_ A conflicting conditional action\ - \ is currently in progress against this resource. Try again.\n\n *\ - \ _HTTP Status Code:_ 409 Conflict\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ PermanentRedirect\n\n * _Description:_\ - \ The bucket you are attempting to access must be addressed using the\ - \ specified endpoint. Send all future requests to this endpoint.\n\n \ - \ * _HTTP Status Code:_ 301 Moved Permanently\n\n * _SOAP Fault Code\ - \ Prefix:_ Client\n\n * * _Code:_ PreconditionFailed\n\n * _Description:_\ - \ At least one of the preconditions you specified did not hold.\n\n \ - \ * _HTTP Status Code:_ 412 Precondition Failed\n\n * _SOAP Fault\ - \ Code Prefix:_ Client\n\n * * _Code:_ Redirect\n\n * _Description:_\ - \ Temporary redirect.\n\n * _HTTP Status Code:_ 307 Moved Temporarily\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ RestoreAlreadyInProgress\n\ - \n * _Description:_ Object restore is already in progress.\n\n *\ - \ _HTTP Status Code:_ 409 Conflict\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ RequestIsNotMultiPartContent\n\n * _Description:_\ - \ Bucket POST must be of the enclosure-type multipart/form-data.\n\n \ - \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ RequestTimeout\n\n * _Description:_ Your\ - \ socket connection to the server was not read from or written to within\ - \ the timeout period.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ RequestTimeTooSkewed\n\ - \n * _Description:_ The difference between the request time and the\ - \ server's time is too large.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ RequestTorrentOfBucketError\n\ - \n * _Description:_ Requesting the torrent file of a bucket is not\ - \ permitted.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ - \ Fault Code Prefix:_ Client\n\n * * _Code:_ SignatureDoesNotMatch\n\ - \n * _Description:_ The request signature we calculated does not match\ - \ the signature you provided. Check your Amazon Web Services secret access\ - \ key and signing method. For more information, see [REST Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html)\ - \ and [SOAP Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html)\ - \ for details.\n\n * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP\ - \ Fault Code Prefix:_ Client\n\n * * _Code:_ ServiceUnavailable\n\ - \n * _Description:_ Service is unable to handle request.\n\n * _HTTP\ - \ Status Code:_ 503 Service Unavailable\n\n * _SOAP Fault Code Prefix:_\ - \ Server\n\n * * _Code:_ SlowDown\n\n * _Description:_ Reduce\ - \ your request rate.\n\n * _HTTP Status Code:_ 503 Slow Down\n\n \ - \ * _SOAP Fault Code Prefix:_ Server\n\n * * _Code:_ TemporaryRedirect\n\ - \n * _Description:_ You are being redirected to the bucket while DNS\ - \ updates.\n\n * _HTTP Status Code:_ 307 Moved Temporarily\n\n *\ - \ _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ TokenRefreshRequired\n\ - \n * _Description:_ The provided token must be refreshed.\n\n *\ - \ _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ - \ Client\n\n * * _Code:_ TooManyBuckets\n\n * _Description:_ You\ - \ have attempted to create more buckets than allowed.\n\n * _HTTP Status\ - \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ - \ * * _Code:_ UnexpectedContent\n\n * _Description:_ This request\ - \ does not support content.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ - \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ UnresolvableGrantByEmailAddress\n\ - \n * _Description:_ The email address you provided does not match any\ - \ account on record.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ - \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ UserKeyMustBeSpecified\n\ - \n * _Description:_ The bucket POST must contain the specified field\ - \ name. If it is specified, check the order of the fields.\n\n * _HTTP\ - \ Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client" - Message: - $ref: '#/components/schemas/Message' - description: The error message contains a generic description of the error - condition in English. It is intended for a human audience. Simple programs - display the message directly to the end user if they encounter an error - condition they don't know how or don't care to handle. Sophisticated programs - with more exhaustive error handling and proper internationalization are - more likely to ignore the error message. - description: Container for all error elements. - ErrorCode: - type: string - ErrorDetails: - type: object - properties: - ErrorCode: - $ref: '#/components/schemas/ErrorCode' - description: "If the V1 `CreateBucketMetadataTableConfiguration` request\ - \ succeeds, but S3 Metadata was unable to create the table, this structure\ - \ contains the error code. The possible error codes and error messages\ - \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ - \ have sufficient permissions to create the required resources. Make sure\ - \ that you have `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable`\ - \ and `s3tables:PutTablePolicy` permissions, and then try again. To create\ - \ a new metadata table, you must delete the metadata configuration for\ - \ this bucket, and then create a new metadata configuration. \n\n * `AccessDeniedWritingToTable`\ - \ \\- Unable to write to the metadata table because of missing resource\ - \ permissions. To fix the resource policy, Amazon S3 needs to create a\ - \ new metadata table. To create a new metadata table, you must delete\ - \ the metadata configuration for this bucket, and then create a new metadata\ - \ configuration.\n\n * `DestinationTableNotFound` \\- The destination\ - \ table doesn't exist. To create a new metadata table, you must delete\ - \ the metadata configuration for this bucket, and then create a new metadata\ - \ configuration.\n\n * `ServerInternalError` \\- An internal error has\ - \ occurred. To create a new metadata table, you must delete the metadata\ - \ configuration for this bucket, and then create a new metadata configuration.\n\ - \n * `TableAlreadyExists` \\- The table that you specified already exists\ - \ in the table bucket's namespace. Specify a different table name. To\ - \ create a new metadata table, you must delete the metadata configuration\ - \ for this bucket, and then create a new metadata configuration.\n\n \ - \ * `TableBucketNotFound` \\- The table bucket that you specified doesn't\ - \ exist in this Amazon Web Services Region and account. Create or choose\ - \ a different table bucket. To create a new metadata table, you must delete\ - \ the metadata configuration for this bucket, and then create a new metadata\ - \ configuration.\n\nIf the V2 `CreateBucketMetadataConfiguration` request\ - \ succeeds, but S3 Metadata was unable to create the table, this structure\ - \ contains the error code. The possible error codes and error messages\ - \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ - \ have sufficient permissions to create the required resources. Make sure\ - \ that you have `s3tables:CreateTableBucket`, `s3tables:CreateNamespace`,\ - \ `s3tables:CreateTable`, `s3tables:GetTable`, `s3tables:PutTablePolicy`,\ - \ `kms:DescribeKey`, and `s3tables:PutTableEncryption` permissions. Additionally,\ - \ ensure that the KMS key used to encrypt the table still exists, is active\ - \ and has a resource policy granting access to the S3 service principals\ - \ '`maintenance.s3tables.amazonaws.com`' and '`metadata.s3.amazonaws.com`'.\ - \ To create a new metadata table, you must delete the metadata configuration\ - \ for this bucket, and then create a new metadata configuration. \n\n\ - \ * `AccessDeniedWritingToTable` \\- Unable to write to the metadata\ - \ table because of missing resource permissions. To fix the resource policy,\ - \ Amazon S3 needs to create a new metadata table. To create a new metadata\ - \ table, you must delete the metadata configuration for this bucket, and\ - \ then create a new metadata configuration.\n\n * `DestinationTableNotFound`\ - \ \\- The destination table doesn't exist. To create a new metadata table,\ - \ you must delete the metadata configuration for this bucket, and then\ - \ create a new metadata configuration.\n\n * `ServerInternalError` \\\ - - An internal error has occurred. To create a new metadata table, you\ - \ must delete the metadata configuration for this bucket, and then create\ - \ a new metadata configuration.\n\n * `JournalTableAlreadyExists` \\\ - - A journal table already exists in the Amazon Web Services managed table\ - \ bucket's namespace. Delete the journal table, and then try again. To\ - \ create a new metadata table, you must delete the metadata configuration\ - \ for this bucket, and then create a new metadata configuration.\n\n \ - \ * `InventoryTableAlreadyExists` \\- An inventory table already exists\ - \ in the Amazon Web Services managed table bucket's namespace. Delete\ - \ the inventory table, and then try again. To create a new metadata table,\ - \ you must delete the metadata configuration for this bucket, and then\ - \ create a new metadata configuration.\n\n * `JournalTableNotAvailable`\ - \ \\- The journal table that the inventory table relies on has a `FAILED`\ - \ status. An inventory table requires a journal table with an `ACTIVE`\ - \ status. To create a new journal or inventory table, you must delete\ - \ the metadata configuration for this bucket, along with any journal or\ - \ inventory tables, and then create a new metadata configuration.\n\n\ - \ * `NoSuchBucket` \\- The specified general purpose bucket does not\ - \ exist." - ErrorMessage: - $ref: '#/components/schemas/ErrorMessage' - description: "If the V1 `CreateBucketMetadataTableConfiguration` request\ - \ succeeds, but S3 Metadata was unable to create the table, this structure\ - \ contains the error message. The possible error codes and error messages\ - \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ - \ have sufficient permissions to create the required resources. Make sure\ - \ that you have `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable`\ - \ and `s3tables:PutTablePolicy` permissions, and then try again. To create\ - \ a new metadata table, you must delete the metadata configuration for\ - \ this bucket, and then create a new metadata configuration. \n\n * `AccessDeniedWritingToTable`\ - \ \\- Unable to write to the metadata table because of missing resource\ - \ permissions. To fix the resource policy, Amazon S3 needs to create a\ - \ new metadata table. To create a new metadata table, you must delete\ - \ the metadata configuration for this bucket, and then create a new metadata\ - \ configuration.\n\n * `DestinationTableNotFound` \\- The destination\ - \ table doesn't exist. To create a new metadata table, you must delete\ - \ the metadata configuration for this bucket, and then create a new metadata\ - \ configuration.\n\n * `ServerInternalError` \\- An internal error has\ - \ occurred. To create a new metadata table, you must delete the metadata\ - \ configuration for this bucket, and then create a new metadata configuration.\n\ - \n * `TableAlreadyExists` \\- The table that you specified already exists\ - \ in the table bucket's namespace. Specify a different table name. To\ - \ create a new metadata table, you must delete the metadata configuration\ - \ for this bucket, and then create a new metadata configuration.\n\n \ - \ * `TableBucketNotFound` \\- The table bucket that you specified doesn't\ - \ exist in this Amazon Web Services Region and account. Create or choose\ - \ a different table bucket. To create a new metadata table, you must delete\ - \ the metadata configuration for this bucket, and then create a new metadata\ - \ configuration.\n\nIf the V2 `CreateBucketMetadataConfiguration` request\ - \ succeeds, but S3 Metadata was unable to create the table, this structure\ - \ contains the error code. The possible error codes and error messages\ - \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ - \ have sufficient permissions to create the required resources. Make sure\ - \ that you have `s3tables:CreateTableBucket`, `s3tables:CreateNamespace`,\ - \ `s3tables:CreateTable`, `s3tables:GetTable`, `s3tables:PutTablePolicy`,\ - \ `kms:DescribeKey`, and `s3tables:PutTableEncryption` permissions. Additionally,\ - \ ensure that the KMS key used to encrypt the table still exists, is active\ - \ and has a resource policy granting access to the S3 service principals\ - \ '`maintenance.s3tables.amazonaws.com`' and '`metadata.s3.amazonaws.com`'.\ - \ To create a new metadata table, you must delete the metadata configuration\ - \ for this bucket, and then create a new metadata configuration. \n\n\ - \ * `AccessDeniedWritingToTable` \\- Unable to write to the metadata\ - \ table because of missing resource permissions. To fix the resource policy,\ - \ Amazon S3 needs to create a new metadata table. To create a new metadata\ - \ table, you must delete the metadata configuration for this bucket, and\ - \ then create a new metadata configuration.\n\n * `DestinationTableNotFound`\ - \ \\- The destination table doesn't exist. To create a new metadata table,\ - \ you must delete the metadata configuration for this bucket, and then\ - \ create a new metadata configuration.\n\n * `ServerInternalError` \\\ - - An internal error has occurred. To create a new metadata table, you\ - \ must delete the metadata configuration for this bucket, and then create\ - \ a new metadata configuration.\n\n * `JournalTableAlreadyExists` \\\ - - A journal table already exists in the Amazon Web Services managed table\ - \ bucket's namespace. Delete the journal table, and then try again. To\ - \ create a new metadata table, you must delete the metadata configuration\ - \ for this bucket, and then create a new metadata configuration.\n\n \ - \ * `InventoryTableAlreadyExists` \\- An inventory table already exists\ - \ in the Amazon Web Services managed table bucket's namespace. Delete\ - \ the inventory table, and then try again. To create a new metadata table,\ - \ you must delete the metadata configuration for this bucket, and then\ - \ create a new metadata configuration.\n\n * `JournalTableNotAvailable`\ - \ \\- The journal table that the inventory table relies on has a `FAILED`\ - \ status. An inventory table requires a journal table with an `ACTIVE`\ - \ status. To create a new journal or inventory table, you must delete\ - \ the metadata configuration for this bucket, along with any journal or\ - \ inventory tables, and then create a new metadata configuration.\n\n\ - \ * `NoSuchBucket` \\- The specified general purpose bucket does not\ - \ exist." - description: 'If an S3 Metadata V1 `CreateBucketMetadataTableConfiguration` - or V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata - was unable to create the table, this structure contains the error code and - error message. - - - If you created your S3 Metadata configuration before July 15, 2025, we recommend - that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) - so that you can expire journal table records and create a live inventory table.' - ErrorDocument: - type: object - properties: - Key: - $ref: '#/components/schemas/ObjectKey' - description: 'The object key name to use when a 4XX class error occurs. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - required: - - Key - description: The error information. - ErrorMessage: - type: string - Errors: - type: array - items: - $ref: '#/components/schemas/Error' - Event: - type: string - enum: - - s3:ReducedRedundancyLostObject - - s3:ObjectCreated:* - - s3:ObjectCreated:Put - - s3:ObjectCreated:Post - - s3:ObjectCreated:Copy - - s3:ObjectCreated:CompleteMultipartUpload - - s3:ObjectRemoved:* - - s3:ObjectRemoved:Delete - - s3:ObjectRemoved:DeleteMarkerCreated - - s3:ObjectRestore:* - - s3:ObjectRestore:Post - - s3:ObjectRestore:Completed - - s3:Replication:* - - s3:Replication:OperationFailedReplication - - s3:Replication:OperationNotTracked - - s3:Replication:OperationMissedThreshold - - s3:Replication:OperationReplicatedAfterThreshold - - s3:ObjectRestore:Delete - - s3:LifecycleTransition - - s3:IntelligentTiering - - s3:ObjectAcl:Put - - s3:LifecycleExpiration:* - - s3:LifecycleExpiration:Delete - - s3:LifecycleExpiration:DeleteMarkerCreated - - s3:ObjectTagging:* - - s3:ObjectTagging:Put - - s3:ObjectTagging:Delete - description:

The bucket event for which to send notifications.

- EventBridgeConfiguration: - type: object - properties: {} - description: A container for specifying the configuration for Amazon EventBridge. - EventList: - type: array - items: - $ref: '#/components/schemas/Event' - ExistingObjectReplication: - type: object - properties: - Status: - $ref: '#/components/schemas/ExistingObjectReplicationStatus' - description: Specifies whether Amazon S3 replicates existing source bucket - objects. - required: - - Status - description: 'Optional configuration to replicate existing source bucket objects. - - - This parameter is no longer supported. To replicate existing objects, see - [Replicating existing objects with S3 Batch Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html) - in the _Amazon S3 User Guide_.' - ExistingObjectReplicationStatus: - type: string - enum: - - Enabled - - Disabled - Expiration: - type: string - ExpirationState: - type: string - enum: - - ENABLED - - DISABLED - ExpirationStatus: - type: string - enum: - - Enabled - - Disabled - ExpiredObjectDeleteMarker: - type: boolean - Expires: - type: string - ExposeHeader: - type: string - ExposeHeaders: - type: array - items: - $ref: '#/components/schemas/ExposeHeader' - Expression: - type: string - ExpressionType: - type: string - enum: - - SQL - FetchOwner: - type: boolean - FieldDelimiter: - type: string - FileHeaderInfo: - type: string - enum: - - USE - - IGNORE - - NONE - FilterRule: - type: object - properties: - Name: - $ref: '#/components/schemas/FilterRuleName' - description: The object key name prefix or suffix identifying one or more - objects to which the filtering rule applies. The maximum length is 1,024 - characters. Overlapping prefixes and suffixes are not supported. For more - information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) - in the _Amazon S3 User Guide_. - Value: - $ref: '#/components/schemas/FilterRuleValue' - description: The value that the filter searches for in object key names. - description: Specifies the Amazon S3 object key name to filter on. An object - key name is the name assigned to an object in your Amazon S3 bucket. You specify - whether to filter on the suffix or prefix of the object key name. A prefix - is a specific string of characters at the beginning of an object key name, - which you can use to organize objects. For example, you can start the key - names of related objects with a prefix, such as `2023-` or `engineering/`. - Then, you can use `FilterRule` to find objects in a bucket with key names - that have the same prefix. A suffix is similar to a prefix, but it is at the - end of the object key name instead of at the beginning. - FilterRuleList: - type: array - items: - $ref: '#/components/schemas/FilterRule' - description:

A list of containers for the key-value pair that defines the - criteria for the filter rule.

- FilterRuleName: - type: string - enum: - - prefix - - suffix - FilterRuleValue: - type: string - GetBucketAbacOutput: - type: object - properties: - AbacStatus: - $ref: '#/components/schemas/AbacStatus' - description: The ABAC status of the general purpose bucket. - GetBucketAbacRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the general purpose bucket. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services account ID of the general purpose bucket's - owner. - required: - - Bucket - GetBucketAccelerateConfigurationOutput: - type: object - properties: - Status: - $ref: '#/components/schemas/BucketAccelerateStatus' - description: The accelerate configuration of the bucket. - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - GetBucketAccelerateConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which the accelerate configuration - is retrieved. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - required: - - Bucket - GetBucketAclOutput: - type: object - properties: - Owner: - $ref: '#/components/schemas/Owner' - description: Container for the bucket owner's ID. - Grants: - $ref: '#/components/schemas/Grants' - description: A list of grants. - GetBucketAclRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketAnalyticsConfigurationOutput: - type: object - properties: - AnalyticsConfiguration: - $ref: '#/components/schemas/AnalyticsConfiguration' - description: The configuration and any analyses for the analytics filter. - GetBucketAnalyticsConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket from which an analytics configuration - is retrieved. - Id: - $ref: '#/components/schemas/AnalyticsId' - description: The ID that identifies the analytics configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - GetBucketCorsOutput: - type: object - properties: - CORSRules: - $ref: '#/components/schemas/CORSRules' - description: A set of origins and methods (cross-origin access that you - want to allow). You can add up to 100 rules to the configuration. - GetBucketCorsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketEncryptionOutput: - type: object - properties: - ServerSideEncryptionConfiguration: - $ref: '#/components/schemas/ServerSideEncryptionConfiguration' - GetBucketEncryptionRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The name of the bucket from which the server-side encryption - configuration is retrieved. - - - **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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - GetBucketIntelligentTieringConfigurationOutput: - type: object - properties: - IntelligentTieringConfiguration: - $ref: '#/components/schemas/IntelligentTieringConfiguration' - description: Container for S3 Intelligent-Tiering configuration. - GetBucketIntelligentTieringConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose configuration you want - to modify or retrieve. - Id: - $ref: '#/components/schemas/IntelligentTieringId' - description: The ID used to identify the S3 Intelligent-Tiering configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - GetBucketInventoryConfigurationOutput: - type: object - properties: - InventoryConfiguration: - $ref: '#/components/schemas/InventoryConfiguration' - description: Specifies the inventory configuration. - GetBucketInventoryConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the inventory configuration - to retrieve. - Id: - $ref: '#/components/schemas/InventoryId' - description: The ID used to identify the inventory configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - GetBucketLifecycleConfigurationOutput: - type: object - properties: - Rules: - $ref: '#/components/schemas/LifecycleRules' - description: Container for a lifecycle rule. - TransitionDefaultMinimumObjectSize: - $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' - description: "Indicates which default minimum object size behavior is applied\ - \ to the lifecycle configuration.\n\nThis parameter applies to general\ - \ purpose buckets only. It isn't supported for directory bucket lifecycle\ - \ configurations.\n\n * `all_storage_classes_128K` \\- Objects smaller\ - \ than 128 KB will not transition to any storage class by default.\n\n\ - \ * `varies_by_storage_class` \\- Objects smaller than 128 KB will transition\ - \ to Glacier Flexible Retrieval or Glacier Deep Archive storage classes.\ - \ By default, all other storage classes will prevent transitions smaller\ - \ than 128 KB. \n\nTo customize the minimum object size for any transition\ - \ you can add a filter that specifies a custom `ObjectSizeGreaterThan`\ - \ or `ObjectSizeLessThan` in the body of your transition rule. Custom\ - \ filters always take precedence over the default transition behavior." - GetBucketLifecycleConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which to get the lifecycle information. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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). - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - required: - - Bucket - GetBucketLocationOutput: - type: object - properties: - LocationConstraint: - $ref: '#/components/schemas/BucketLocationConstraint' - description: 'Specifies the Region where the bucket resides. For a list - of all the Amazon S3 supported location constraints by Region, see [Regions - and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). - - - Buckets in Region `us-east-1` have a LocationConstraint of `null`. Buckets - with a LocationConstraint of `EU` reside in `eu-west-1`.' - GetBucketLocationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketLoggingOutput: - type: object - properties: - LoggingEnabled: - $ref: '#/components/schemas/LoggingEnabled' - GetBucketLoggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name for which to get the logging information. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketMetadataConfigurationOutput: - type: object - properties: - GetBucketMetadataConfigurationResult: - $ref: '#/components/schemas/GetBucketMetadataConfigurationResult' - description: The metadata configuration for the general purpose bucket. - GetBucketMetadataConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that corresponds to the metadata - configuration that you want to retrieve. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected owner of the general purpose bucket that you want - to retrieve the metadata table configuration for. - required: - - Bucket - GetBucketMetadataConfigurationResult: - type: object - properties: - MetadataConfigurationResult: - $ref: '#/components/schemas/MetadataConfigurationResult' - description: The metadata configuration for a general purpose bucket. - required: - - MetadataConfigurationResult - description: The S3 Metadata configuration for a general purpose bucket. - GetBucketMetadataTableConfigurationOutput: - type: object - properties: - GetBucketMetadataTableConfigurationResult: - $ref: '#/components/schemas/GetBucketMetadataTableConfigurationResult' - description: The metadata table configuration for the general purpose bucket. - GetBucketMetadataTableConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that corresponds to the metadata - table configuration that you want to retrieve. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected owner of the general purpose bucket that you want - to retrieve the metadata table configuration for. - required: - - Bucket - GetBucketMetadataTableConfigurationResult: - type: object - properties: - MetadataTableConfigurationResult: - $ref: '#/components/schemas/MetadataTableConfigurationResult' - description: The V1 S3 Metadata configuration for a general purpose bucket. - Status: - $ref: '#/components/schemas/MetadataTableStatus' - description: "The status of the metadata table. The status values are:\n\ - \n * `CREATING` \\- The metadata table is in the process of being created\ - \ in the specified table bucket.\n\n * `ACTIVE` \\- The metadata table\ - \ has been created successfully, and records are being delivered to the\ - \ table. \n\n * `FAILED` \\- Amazon S3 is unable to create the metadata\ - \ table, or Amazon S3 is unable to deliver records. See `ErrorDetails`\ - \ for details." - Error: - $ref: '#/components/schemas/ErrorDetails' - description: If the `CreateBucketMetadataTableConfiguration` request succeeds, - but S3 Metadata was unable to create the table, this structure contains - the error code and error message. - required: - - MetadataTableConfigurationResult - - Status - description: 'The V1 S3 Metadata configuration for a general purpose bucket. - - - If you created your S3 Metadata configuration before July 15, 2025, we recommend - that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) - so that you can expire journal table records and create a live inventory table.' - GetBucketMetricsConfigurationOutput: - type: object - properties: - MetricsConfiguration: - $ref: '#/components/schemas/MetricsConfiguration' - description: Specifies the metrics configuration. - GetBucketMetricsConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the metrics configuration - to retrieve. - Id: - $ref: '#/components/schemas/MetricsId' - description: The ID used to identify the metrics configuration. The ID has - a 64 character limit and can only contain letters, numbers, periods, dashes, - and underscores. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - GetBucketNotificationConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketOwnershipControlsOutput: - type: object - properties: - OwnershipControls: - $ref: '#/components/schemas/OwnershipControls' - description: The `OwnershipControls` (BucketOwnerEnforced, BucketOwnerPreferred, - or ObjectWriter) currently in effect for this Amazon S3 bucket. - GetBucketOwnershipControlsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose `OwnershipControls` - you want to retrieve. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketPolicyOutput: - type: object - properties: - Policy: - $ref: '#/components/schemas/Policy' - description: The bucket policy as a JSON document. - GetBucketPolicyRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - - Object Lambda access points are not supported by directory buckets.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - GetBucketPolicyStatusOutput: - type: object - properties: - PolicyStatus: - $ref: '#/components/schemas/PolicyStatus' - description: The policy status for the specified bucket. - GetBucketPolicyStatusRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose policy status you want - to retrieve. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketReplicationOutput: - type: object - properties: - ReplicationConfiguration: - $ref: '#/components/schemas/ReplicationConfiguration' - GetBucketReplicationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name for which to get the replication information. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketRequestPaymentOutput: - type: object - properties: - Payer: - $ref: '#/components/schemas/Payer' - description: Specifies who pays for the download and request fees. - GetBucketRequestPaymentRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which to get the payment request - configuration - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketTaggingOutput: - type: object - properties: - TagSet: - $ref: '#/components/schemas/TagSet' - description: Contains the tag set. - required: - - TagSet - GetBucketTaggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which to get the tagging information. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketVersioningOutput: - type: object - properties: - Status: - $ref: '#/components/schemas/BucketVersioningStatus' - description: The versioning state of the bucket. - MFADelete: - $ref: '#/components/schemas/MFADeleteStatus' - description: Specifies whether MFA delete is enabled in the bucket versioning - configuration. This element is only returned if the bucket has been configured - with MFA delete. If the bucket has never been so configured, this element - is not returned. - GetBucketVersioningRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which to get the versioning information. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetBucketWebsiteOutput: - type: object - properties: - RedirectAllRequestsTo: - $ref: '#/components/schemas/RedirectAllRequestsTo' - description: Specifies the redirect behavior of all requests to a website - endpoint of an Amazon S3 bucket. - IndexDocument: - $ref: '#/components/schemas/IndexDocument' - description: The name of the index document for the website (for example - `index.html`). - ErrorDocument: - $ref: '#/components/schemas/ErrorDocument' - description: The object key name of the website error document to use for - 4XX class errors. - RoutingRules: - $ref: '#/components/schemas/RoutingRules' - description: Rules that define when a redirect is applied and the redirect - behavior. - GetBucketWebsiteRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name for which to get the website configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetObjectAclOutput: - type: object - properties: - Owner: - $ref: '#/components/schemas/Owner' - description: Container for the bucket owner's ID. - Grants: - $ref: '#/components/schemas/Grants' - description: A list of grants. - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - GetObjectAclRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key of the object for which to get the ACL information. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID used to reference a specific version of the object. - - - This functionality is not supported for directory buckets.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - GetObjectAttributesOutput: - type: object - properties: - DeleteMarker: - $ref: '#/components/schemas/DeleteMarker' - description: '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. To learn more about delete markers, see [Working - with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). - - - This functionality is not supported for directory buckets.' - LastModified: - $ref: '#/components/schemas/LastModified' - description: Date and time when the object was last modified. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'The version ID of the object. - - - This functionality is not supported for directory buckets.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ETag: - $ref: '#/components/schemas/ETag' - description: An ETag is an opaque identifier assigned by a web server to - a specific version of a resource found at a URL. - Checksum: - $ref: '#/components/schemas/Checksum' - description: The checksum or digest of the object. - ObjectParts: - $ref: '#/components/schemas/GetObjectAttributesParts' - description: A collection of parts associated with a multipart upload. - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). - - - **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` - (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` - (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' - ObjectSize: - $ref: '#/components/schemas/ObjectSize' - description: The size of the object in bytes. - GetObjectAttributesParts: - type: object - properties: - TotalPartsCount: - $ref: '#/components/schemas/PartsCount' - description: The total number of parts. - PartNumberMarker: - $ref: '#/components/schemas/PartNumberMarker' - description: The marker for the current part. - NextPartNumberMarker: - $ref: '#/components/schemas/NextPartNumberMarker' - description: When a list is truncated, this element specifies the last part - in the list, as well as the value to use for the `PartNumberMarker` request - parameter in a subsequent request. - MaxParts: - $ref: '#/components/schemas/MaxParts' - description: The maximum number of parts allowed in the response. - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Indicates whether the returned list of parts is truncated. - A value of `true` indicates that the list was truncated. A list can be - truncated if the number of parts exceeds the limit returned in the `MaxParts` - element. - Parts: - $ref: '#/components/schemas/PartsList' - description: "A container for elements related to a particular part. A response\ - \ can contain zero or more `Parts` elements.\n\n * **General purpose\ - \ buckets** \\- For `GetObjectAttributes`, if an 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 the `Part` element.\n\n *\ - \ **Directory buckets** \\- For `GetObjectAttributes`, regardless of whether\ - \ an additional checksum is applied to the object specified in the request,\ - \ the response returns the `Part` element." - description: A collection of parts associated with a multipart upload. - GetObjectAttributesRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The object key. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: '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.' - MaxParts: - $ref: '#/components/schemas/MaxParts' - description: Sets the maximum number of parts to return. For more information, - see [Uploading and copying objects using multipart upload in Amazon S3 - ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html) - in the _Amazon Simple Storage Service user guide_. - PartNumberMarker: - $ref: '#/components/schemas/PartNumberMarker' - description: Specifies the part after which listing should begin. Only parts - with higher part numbers will be listed. For more information, see [Uploading - and copying objects using multipart upload in Amazon S3 ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html) - in the _Amazon Simple Storage Service user guide_. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: 'Specifies the algorithm to use when encrypting the object - (for example, AES256). - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ObjectAttributes: - $ref: '#/components/schemas/ObjectAttributesList' - description: Specifies the fields at the root level that you want returned - in the response. Fields that you do not specify are not returned. - required: - - Bucket - - Key - - ObjectAttributes - GetObjectLegalHoldOutput: - type: object - properties: - LegalHold: - $ref: '#/components/schemas/ObjectLockLegalHold' - description: The current legal hold status for the specified object. - GetObjectLegalHoldRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key name for the object whose legal hold status you want - to retrieve. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The version ID of the object whose legal hold status you want - to retrieve. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - GetObjectLockConfigurationOutput: - type: object - properties: - ObjectLockConfiguration: - $ref: '#/components/schemas/ObjectLockConfiguration' - description: The specified bucket's Object Lock configuration. - GetObjectLockConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket whose Object Lock configuration you want to retrieve. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GetObjectOutput: - type: object - properties: - Body: - $ref: '#/components/schemas/StreamingBlob' - description: Object data. - DeleteMarker: - $ref: '#/components/schemas/DeleteMarker' - description: "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.\n\n * 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.\n\n * 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." - AcceptRanges: - $ref: '#/components/schemas/AcceptRanges' - description: Indicates that a range of bytes was specified in the request. - Expiration: - $ref: '#/components/schemas/Expiration' - description: 'If the object expiration is configured (see [ `PutBucketLifecycleConfiguration` - ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)), - 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. - - - Object expiration information is not returned in directory buckets and - this header returns the value "`NotImplemented`" in all responses for - directory buckets.' - Restore: - $ref: '#/components/schemas/Restore' - description: 'Provides information about object restoration action and expiration - time of the restored object copy. - - - This functionality is not supported for directory buckets. Directory buckets - only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) - in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access - storage class) in Dedicated Local Zones.' - LastModified: - $ref: '#/components/schemas/LastModified' - description: '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.' - ContentLength: - $ref: '#/components/schemas/ContentLength' - description: Size of the body in bytes. - ETag: - $ref: '#/components/schemas/ETag' - description: An entity tag (ETag) is an opaque identifier assigned by a - web server to a specific version of a resource found at a URL. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32` checksum of the object. - This checksum is only present if the object was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. - For more information, see [Checking object integrity in the Amazon S3 - User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum was uploaded with the object. - For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type, which determines how part-level checksums - are combined to create an object-level checksum for multipart objects. - You can use this header response to verify that the checksum type that - is received is the same checksum type that was specified in the `CreateMultipartUpload` - request. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - MissingMeta: - $ref: '#/components/schemas/MissingMeta' - description: '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.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID of the object. - - - This functionality is not supported for directory buckets.' - CacheControl: - $ref: '#/components/schemas/CacheControl' - description: Specifies caching behavior along the request/reply chain. - ContentDisposition: - $ref: '#/components/schemas/ContentDisposition' - description: Specifies presentational information for the object. - ContentEncoding: - $ref: '#/components/schemas/ContentEncoding' - description: 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. - ContentLanguage: - $ref: '#/components/schemas/ContentLanguage' - description: The language the content is in. - ContentRange: - $ref: '#/components/schemas/ContentRange' - description: The portion of the object returned in the response. - ContentType: - $ref: '#/components/schemas/ContentType' - description: A standard MIME type describing the format of the object data. - Expires: - $ref: '#/components/schemas/Expires' - description: The date and time at which the object is no longer cacheable. - WebsiteRedirectLocation: - $ref: '#/components/schemas/WebsiteRedirectLocation' - description: '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.' - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - Metadata: - $ref: '#/components/schemas/Metadata' - description: A map of metadata to store with the object in S3. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the object uses an S3 Bucket Key for server-side - encryption with Key Management Service (KMS) keys (SSE-KMS). - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: 'Provides storage class information of the object. Amazon S3 - returns this header for all objects except for S3 Standard storage class - objects. - - - **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` - (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` - (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ReplicationStatus: - $ref: '#/components/schemas/ReplicationStatus' - description: '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.' - PartsCount: - $ref: '#/components/schemas/PartsCount' - description: The count of parts this object has. This value is only returned - if you specify `partNumber` in your request and the object was uploaded - as a multipart upload. - TagCount: - $ref: '#/components/schemas/TagCount' - description: 'The number of tags, if any, on the object, when you have the - relevant permission to read object tags. - - - You can use [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) - to retrieve the tag set associated with an object. - - - This functionality is not supported for directory buckets.' - ObjectLockMode: - $ref: '#/components/schemas/ObjectLockMode' - description: 'The Object Lock mode that''s currently in place for this object. - - - This functionality is not supported for directory buckets.' - ObjectLockRetainUntilDate: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - description: 'The date and time when this object''s Object Lock will expire. - - - This functionality is not supported for directory buckets.' - ObjectLockLegalHoldStatus: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: '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.' - GetObjectRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - 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. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - IfMatch: - $ref: '#/components/schemas/IfMatch' - description: '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](https://tools.ietf.org/html/rfc7232).' - IfModifiedSince: - $ref: '#/components/schemas/IfModifiedSince' - description: '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](https://tools.ietf.org/html/rfc7232).' - IfNoneMatch: - $ref: '#/components/schemas/IfNoneMatch' - description: '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](https://tools.ietf.org/html/rfc7232).' - IfUnmodifiedSince: - $ref: '#/components/schemas/IfUnmodifiedSince' - description: '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](https://tools.ietf.org/html/rfc7232).' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Key of the object to get. - Range: - $ref: '#/components/schemas/Range' - description: 'Downloads the specified byte range of an object. For more - information about the HTTP Range header, see . - - - Amazon S3 doesn''t support retrieving multiple ranges of data per `GET` - request.' - ResponseCacheControl: - $ref: '#/components/schemas/ResponseCacheControl' - description: Sets the `Cache-Control` header of the response. - ResponseContentDisposition: - $ref: '#/components/schemas/ResponseContentDisposition' - description: Sets the `Content-Disposition` header of the response. - ResponseContentEncoding: - $ref: '#/components/schemas/ResponseContentEncoding' - description: Sets the `Content-Encoding` header of the response. - ResponseContentLanguage: - $ref: '#/components/schemas/ResponseContentLanguage' - description: Sets the `Content-Language` header of the response. - ResponseContentType: - $ref: '#/components/schemas/ResponseContentType' - description: Sets the `Content-Type` header of the response. - ResponseExpires: - $ref: '#/components/schemas/ResponseExpires' - description: Sets the `Expires` header of the response. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: "Version ID used to reference a specific version of the object.\n\ - \nBy default, the `GetObject` operation returns the current version of\ - \ an object. To return a different version, use the `versionId` subresource.\n\ - \n * 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.\n\ - \n * 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.\n\n * **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.\n\nFor more information about versioning, see [PutBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html)." - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: "Specifies the algorithm to use when decrypting the object\ - \ (for example, `AES256`).\n\nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\ - \n * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ - \nFor more information about SSE-C, see [Server-Side Encryption (Using\ - \ Customer-Provided Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported\ - \ for directory buckets." - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: "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.\n\nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\n\ - \ * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ - \nFor more information about SSE-C, see [Server-Side Encryption (Using\ - \ Customer-Provided Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported\ - \ for directory buckets." - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: "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.\n\nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\n\ - \ * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ - \nFor more information about SSE-C, see [Server-Side Encryption (Using\ - \ Customer-Provided Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ - \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported\ - \ for directory buckets." - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: Part number of the object being read. This is a positive integer - between 1 and 10,000. Effectively performs a 'ranged' GET request for - the part specified. Useful for downloading just a part of an object. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ChecksumMode: - $ref: '#/components/schemas/ChecksumMode' - description: To retrieve the checksum, this mode must be enabled. - required: - - Bucket - - Key - GetObjectResponseStatusCode: - type: integer - GetObjectRetentionOutput: - type: object - properties: - Retention: - $ref: '#/components/schemas/ObjectLockRetention' - description: The container element for an object's retention settings. - GetObjectRetentionRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket name containing the object whose retention settings - you want to retrieve. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key name for the object whose retention settings you want - to retrieve. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The version ID for the object whose retention settings you - want to retrieve. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - GetObjectTaggingOutput: - type: object - properties: - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The versionId of the object for which you got the tagging information. - TagSet: - $ref: '#/components/schemas/TagSet' - description: Contains the tag set. - required: - - TagSet - GetObjectTaggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket name containing the object for which to get the - tagging information. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which to get the tagging information. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The versionId of the object for which to get the tagging information. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - required: - - Bucket - - Key - GetObjectTorrentOutput: - type: object - properties: - Body: - $ref: '#/components/schemas/StreamingBlob' - description: A Bencoded dictionary as defined by the BitTorrent specification - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - GetObjectTorrentRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the object for which to get - the torrent files. - Key: - $ref: '#/components/schemas/ObjectKey' - description: The object key for which to get the information. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - GetPublicAccessBlockOutput: - type: object - properties: - PublicAccessBlockConfiguration: - $ref: '#/components/schemas/PublicAccessBlockConfiguration' - description: The `PublicAccessBlock` configuration currently in effect for - this Amazon S3 bucket. - GetPublicAccessBlockRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose `PublicAccessBlock` - configuration you want to retrieve. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - GlacierJobParameters: - type: object - properties: - Tier: - $ref: '#/components/schemas/Tier' - description: Retrieval tier at which the restore will be processed. - required: - - Tier - description: Container for S3 Glacier job parameters. - Grant: - type: object - properties: - Grantee: - $ref: '#/components/schemas/Grantee' - description: The person being granted permissions. - Permission: - $ref: '#/components/schemas/Permission' - description: Specifies the permission given to the grantee. - description: Container for grant information. - GrantFullControl: - type: string - GrantRead: - type: string - GrantReadACP: - type: string - GrantWrite: - type: string - GrantWriteACP: - type: string - Grantee: - type: object - properties: - DisplayName: - $ref: '#/components/schemas/DisplayName' - description: '' - EmailAddress: - $ref: '#/components/schemas/EmailAddress' - description: '' - ID: - $ref: '#/components/schemas/ID' - description: The canonical user ID of the grantee. - URI: - $ref: '#/components/schemas/URI' - description: URI of the grantee group. - Type: - $ref: '#/components/schemas/Type' - description: Type of grantee - required: - - Type - description: Container for the person being granted permissions. - Grants: - type: array - items: - $ref: '#/components/schemas/Grant' - HeadBucketOutput: - type: object - properties: - BucketArn: - $ref: '#/components/schemas/S3RegionalOrS3ExpressBucketArnString' - description: 'The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely - identify Amazon Web Services resources across all of Amazon Web Services. - - - This parameter is only supported for S3 directory buckets. For more information, - see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).' - BucketLocationType: - $ref: '#/components/schemas/LocationType' - description: 'The type of location where the bucket is created. - - - This functionality is only supported by directory buckets.' - BucketLocationName: - $ref: '#/components/schemas/BucketLocationName' - description: 'The name of the location where the bucket will be created. - - - For directory buckets, the Zone ID of the Availability Zone or the Local - Zone where the bucket is created. An example Zone ID value for an Availability - Zone is `usw2-az1`. - - - This functionality is only supported by directory buckets.' - BucketRegion: - $ref: '#/components/schemas/Region' - description: The Region that the bucket is located. - AccessPointAlias: - $ref: '#/components/schemas/AccessPointAlias' - description: 'Indicates whether the bucket name used in the request is an - access point alias. - - - For directory buckets, the value of this field is `false`.' - HeadBucketRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - HeadObjectOutput: - type: object - properties: - DeleteMarker: - $ref: '#/components/schemas/DeleteMarker' - description: '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.' - AcceptRanges: - $ref: '#/components/schemas/AcceptRanges' - description: Indicates that a range of bytes was specified. - Expiration: - $ref: '#/components/schemas/Expiration' - description: 'If the object expiration is configured (see [ `PutBucketLifecycleConfiguration` - ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)), - 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. - - - Object expiration information is not returned in directory buckets and - this header returns the value "`NotImplemented`" in all responses for - directory buckets.' - Restore: - $ref: '#/components/schemas/Restore' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) - 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations). - - - This functionality is not supported for directory buckets. Directory buckets - only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) - in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access - storage class) in Dedicated Local Zones.' - ArchiveStatus: - $ref: '#/components/schemas/ArchiveStatus' - description: 'The archive state of the head object. - - - This functionality is not supported for directory buckets.' - LastModified: - $ref: '#/components/schemas/LastModified' - description: Date and time when the object was last modified. - ContentLength: - $ref: '#/components/schemas/ContentLength' - description: Size of the body in bytes. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. - For more information, see [Checking object integrity in the Amazon S3 - User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type, which determines how part-level checksums - are combined to create an object-level checksum for multipart objects. - You can use this header response to verify that the checksum type that - is received is the same checksum type that was specified in `CreateMultipartUpload` - request. For more information, see [Checking object integrity in the Amazon - S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ETag: - $ref: '#/components/schemas/ETag' - description: An entity tag (ETag) is an opaque identifier assigned by a - web server to a specific version of a resource found at a URL. - MissingMeta: - $ref: '#/components/schemas/MissingMeta' - description: '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.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID of the object. - - - This functionality is not supported for directory buckets.' - CacheControl: - $ref: '#/components/schemas/CacheControl' - description: Specifies caching behavior along the request/reply chain. - ContentDisposition: - $ref: '#/components/schemas/ContentDisposition' - description: Specifies presentational information for the object. - ContentEncoding: - $ref: '#/components/schemas/ContentEncoding' - description: 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. - ContentLanguage: - $ref: '#/components/schemas/ContentLanguage' - description: The language the content is in. - ContentType: - $ref: '#/components/schemas/ContentType' - description: A standard MIME type describing the format of the object data. - ContentRange: - $ref: '#/components/schemas/ContentRange' - description: The portion of the object returned in the response for a `GET` - request. - Expires: - $ref: '#/components/schemas/Expires' - description: The date and time at which the object is no longer cacheable. - WebsiteRedirectLocation: - $ref: '#/components/schemas/WebsiteRedirectLocation' - description: '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.' - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - Metadata: - $ref: '#/components/schemas/Metadata' - description: A map of metadata to store with the object in S3. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the object uses an S3 Bucket Key for server-side - encryption with Key Management Service (KMS) keys (SSE-KMS). - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). - - - **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` - (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` - (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ReplicationStatus: - $ref: '#/components/schemas/ReplicationStatus' - description: "Amazon S3 can return this header if your request involves\ - \ a bucket that is either a source or a destination in a replication rule.\n\ - \nIn 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:\n\n * **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.\n\n\ - 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.\n\n * **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.\n\n * **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. \n\nFor more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).\n\ - \nThis functionality is not supported for directory buckets." - PartsCount: - $ref: '#/components/schemas/PartsCount' - description: The count of parts this object has. This value is only returned - if you specify `partNumber` in your request and the object was uploaded - as a multipart upload. - TagCount: - $ref: '#/components/schemas/TagCount' - description: 'The number of tags, if any, on the object, when you have the - relevant permission to read object tags. - - - You can use [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) - to retrieve the tag set associated with an object. - - - This functionality is not supported for directory buckets.' - ObjectLockMode: - $ref: '#/components/schemas/ObjectLockMode' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - - This functionality is not supported for directory buckets.' - ObjectLockRetainUntilDate: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - description: '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.' - ObjectLockLegalHoldStatus: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - - - This functionality is not supported for directory buckets.' - HeadObjectRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - IfMatch: - $ref: '#/components/schemas/IfMatch' - description: "Return the object only if its entity tag (ETag) is the same\ - \ as the one specified; otherwise, return a 412 (precondition failed)\ - \ error.\n\nIf both of the `If-Match` and `If-Unmodified-Since` headers\ - \ are present in the request as follows:\n\n * `If-Match` condition evaluates\ - \ to `true`, and;\n\n * `If-Unmodified-Since` condition evaluates to\ - \ `false`;\n\nThen Amazon S3 returns `200 OK` and the data requested.\n\ - \nFor more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." - IfModifiedSince: - $ref: '#/components/schemas/IfModifiedSince' - description: "Return the object only if it has been modified since the specified\ - \ time; otherwise, return a 304 (not modified) error.\n\nIf both of the\ - \ `If-None-Match` and `If-Modified-Since` headers are present in the request\ - \ as follows:\n\n * `If-None-Match` condition evaluates to `false`, and;\n\ - \n * `If-Modified-Since` condition evaluates to `true`;\n\nThen Amazon\ - \ S3 returns the `304 Not Modified` response code.\n\nFor more information\ - \ about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." - IfNoneMatch: - $ref: '#/components/schemas/IfNoneMatch' - description: "Return the object only if its entity tag (ETag) is different\ - \ from the one specified; otherwise, return a 304 (not modified) error.\n\ - \nIf both of the `If-None-Match` and `If-Modified-Since` headers are present\ - \ in the request as follows:\n\n * `If-None-Match` condition evaluates\ - \ to `false`, and;\n\n * `If-Modified-Since` condition evaluates to `true`;\n\ - \nThen Amazon S3 returns the `304 Not Modified` response code.\n\nFor\ - \ more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." - IfUnmodifiedSince: - $ref: '#/components/schemas/IfUnmodifiedSince' - description: "Return the object only if it has not been modified since the\ - \ specified time; otherwise, return a 412 (precondition failed) error.\n\ - \nIf both of the `If-Match` and `If-Unmodified-Since` headers are present\ - \ in the request as follows:\n\n * `If-Match` condition evaluates to\ - \ `true`, and;\n\n * `If-Unmodified-Since` condition evaluates to `false`;\n\ - \nThen Amazon S3 returns `200 OK` and the data requested.\n\nFor more\ - \ information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." - Key: - $ref: '#/components/schemas/ObjectKey' - description: The object key. - Range: - $ref: '#/components/schemas/Range' - description: HeadObject returns only the metadata for an object. If the - Range is satisfiable, only the `ContentLength` is affected in the response. - If the Range is not satisfiable, S3 returns a `416 - Requested Range Not - Satisfiable` error. - ResponseCacheControl: - $ref: '#/components/schemas/ResponseCacheControl' - description: Sets the `Cache-Control` header of the response. - ResponseContentDisposition: - $ref: '#/components/schemas/ResponseContentDisposition' - description: Sets the `Content-Disposition` header of the response. - ResponseContentEncoding: - $ref: '#/components/schemas/ResponseContentEncoding' - description: Sets the `Content-Encoding` header of the response. - ResponseContentLanguage: - $ref: '#/components/schemas/ResponseContentLanguage' - description: Sets the `Content-Language` header of the response. - ResponseContentType: - $ref: '#/components/schemas/ResponseContentType' - description: Sets the `Content-Type` header of the response. - ResponseExpires: - $ref: '#/components/schemas/ResponseExpires' - description: Sets the `Expires` header of the response. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: '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.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: 'Specifies the algorithm to use when encrypting the object - (for example, AES256). - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: Part number of the object being read. This is a positive integer - between 1 and 10,000. Effectively performs a 'ranged' HEAD request for - the part specified. Useful querying about the size of the part and the - number of parts in this object. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ChecksumMode: - $ref: '#/components/schemas/ChecksumMode' - description: 'To retrieve the checksum, this parameter must be enabled. - - - **General purpose buckets** \- If you enable checksum mode and the object - is uploaded with a [checksum](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html) - and encrypted with an Key Management Service (KMS) key, you must have - permission to use the `kms:Decrypt` action to retrieve the checksum. - - - **Directory buckets** \- If you enable `ChecksumMode` and the object is - encrypted with Amazon Web Services Key Management Service (Amazon Web - Services KMS), you must also have the `kms:GenerateDataKey` and `kms:Decrypt` - permissions in IAM identity-based policies and KMS key policies for the - KMS key to retrieve the checksum of the object.' - required: - - Bucket - - Key - HostName: - type: string - HttpErrorCodeReturnedEquals: - type: string - HttpRedirectCode: - type: string - ID: - type: string - IdempotencyParameterMismatch: - type: object - properties: {} - description: 'Parameters on this idempotent request are inconsistent with parameters - used in previous request(s). - - - For a list of error codes and more information on Amazon S3 errors, see [Error - codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). - - - Idempotency ensures that an API request completes no more than one time. With - an idempotent request, if the original request completes successfully, any - subsequent retries complete successfully without performing any further actions.' - IfMatch: - type: string - IfMatchInitiatedTime: - type: string - format: date-time - IfMatchLastModifiedTime: - type: string - format: date-time - IfMatchSize: - type: integer - format: int64 - IfModifiedSince: - type: string - format: date-time - IfNoneMatch: - type: string - IfUnmodifiedSince: - type: string - format: date-time - IndexDocument: - type: object - properties: - Suffix: - $ref: '#/components/schemas/Suffix' - description: 'A suffix that is appended to a request that is for a directory - on the website endpoint. (For example, if the suffix is `index.html` and - you make a request to `samplebucket/images/`, the data that is returned - will be for the object with the key name `images/index.html`.) The suffix - must not be empty and must not include a slash character. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - required: - - Suffix - description: Container for the `Suffix` element. - Initiated: - type: string - format: date-time - Initiator: - type: object - properties: - ID: - $ref: '#/components/schemas/ID' - description: '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: - $ref: '#/components/schemas/DisplayName' - description: This functionality is not supported for directory buckets. - description: Container element that identifies who initiated the multipart upload. - InputSerialization: - type: object - properties: - CSV: - $ref: '#/components/schemas/CSVInput' - description: Describes the serialization of a CSV-encoded object. - CompressionType: - $ref: '#/components/schemas/CompressionType' - description: 'Specifies object''s compression format. Valid values: NONE, - GZIP, BZIP2. Default Value: NONE.' - JSON: - $ref: '#/components/schemas/JSONInput' - description: Specifies JSON as object's input serialization format. - Parquet: - $ref: '#/components/schemas/ParquetInput' - description: Specifies Parquet as object's input serialization format. - description: Describes the serialization format of the object. - IntelligentTieringAccessTier: - type: string - enum: - - ARCHIVE_ACCESS - - DEEP_ARCHIVE_ACCESS - IntelligentTieringAndOperator: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: An object key name prefix that identifies the subset of objects - to which the configuration applies. - Tags: - $ref: '#/components/schemas/TagSet' - description: All of these tags must exist in the object's tag set in order - for the configuration to apply. - description: A container for specifying S3 Intelligent-Tiering filters. The - filters determine the subset of objects to which the rule applies. - IntelligentTieringConfiguration: - type: object - properties: - Id: - $ref: '#/components/schemas/IntelligentTieringId' - description: The ID used to identify the S3 Intelligent-Tiering configuration. - Filter: - $ref: '#/components/schemas/IntelligentTieringFilter' - description: Specifies a bucket filter. The configuration only includes - objects that meet the filter's criteria. - Status: - $ref: '#/components/schemas/IntelligentTieringStatus' - description: Specifies the status of the configuration. - Tierings: - $ref: '#/components/schemas/TieringList' - description: Specifies the S3 Intelligent-Tiering storage class tier of - the configuration. - required: - - Id - - Status - - Tierings - description: 'Specifies the S3 Intelligent-Tiering configuration for an Amazon - S3 bucket. - - - For information about the S3 Intelligent-Tiering storage class, see [Storage - class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).' - IntelligentTieringConfigurationList: - type: array - items: - $ref: '#/components/schemas/IntelligentTieringConfiguration' - IntelligentTieringDays: - type: integer - IntelligentTieringFilter: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'An object key name prefix that identifies the subset of objects - to which the rule applies. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - Tag: - $ref: '#/components/schemas/Tag' - And: - $ref: '#/components/schemas/IntelligentTieringAndOperator' - description: A conjunction (logical AND) of predicates, which is used in - evaluating a metrics filter. The operator must have at least two predicates, - and an object must match all of the predicates in order for the filter - to apply. - description: The `Filter` is used to identify objects that the S3 Intelligent-Tiering - configuration applies to. - IntelligentTieringId: - type: string - IntelligentTieringStatus: - type: string - enum: - - Enabled - - Disabled - InvalidObjectState: - type: object - properties: - StorageClass: - $ref: '#/components/schemas/StorageClass' - AccessTier: - $ref: '#/components/schemas/IntelligentTieringAccessTier' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). - Otherwise, this operation returns an `InvalidObjectState` error. For information - about restoring archived objects, see [Restoring Archived Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) - in the _Amazon S3 User Guide_.' - InvalidRequest: - type: object - properties: {} - description: "You may receive this error in multiple cases. Depending on the\ - \ reason for the error, you may receive one of the messages below:\n\n *\ - \ Cannot specify both a write offset value and user-defined object metadata\ - \ for existing objects.\n\n * Checksum Type mismatch occurred, expected checksum\ - \ Type: sha1, actual checksum Type: crc32c.\n\n * Request body cannot be\ - \ empty when 'write offset' is specified." - InvalidWriteOffset: - type: object - properties: {} - description: The write offset value that you specified does not match the current - object size. - InventoryConfiguration: - type: object - properties: - Destination: - $ref: '#/components/schemas/InventoryDestination' - description: Contains information about where to publish the inventory results. - IsEnabled: - $ref: '#/components/schemas/IsEnabled' - description: Specifies whether the inventory is enabled or disabled. If - set to `True`, an inventory list is generated. If set to `False`, no inventory - list is generated. - Filter: - $ref: '#/components/schemas/InventoryFilter' - description: Specifies an inventory filter. The inventory only includes - objects that meet the filter's criteria. - Id: - $ref: '#/components/schemas/InventoryId' - description: The ID used to identify the inventory configuration. - IncludedObjectVersions: - $ref: '#/components/schemas/InventoryIncludedObjectVersions' - description: Object versions to include in the inventory list. If set to - `All`, the list includes all the object versions, which adds the version-related - fields `VersionId`, `IsLatest`, and `DeleteMarker` to the list. If set - to `Current`, the list does not contain these version-related fields. - OptionalFields: - $ref: '#/components/schemas/InventoryOptionalFields' - description: Contains the optional fields that are included in the inventory - results. - Schedule: - $ref: '#/components/schemas/InventorySchedule' - description: Specifies the schedule for generating inventory results. - required: - - Destination - - IsEnabled - - Id - - IncludedObjectVersions - - Schedule - description: Specifies the S3 Inventory configuration for an Amazon S3 bucket. - For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) - in the _Amazon S3 API Reference_. - InventoryConfigurationList: - type: array - items: - $ref: '#/components/schemas/InventoryConfiguration' - InventoryConfigurationState: - type: string - enum: - - ENABLED - - DISABLED - InventoryDestination: - type: object - properties: - S3BucketDestination: - $ref: '#/components/schemas/InventoryS3BucketDestination' - description: Contains the bucket name, file format, bucket owner (optional), - and prefix (optional) where inventory results are published. - required: - - S3BucketDestination - description: Specifies the S3 Inventory configuration for an Amazon S3 bucket. - InventoryEncryption: - type: object - properties: - SSES3: - $ref: '#/components/schemas/SSES3' - description: Specifies the use of SSE-S3 to encrypt delivered inventory - reports. - SSEKMS: - $ref: '#/components/schemas/SSEKMS' - description: Specifies the use of SSE-KMS to encrypt delivered inventory - reports. - description: Contains the type of server-side encryption used to encrypt the - S3 Inventory results. - InventoryFilter: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: The prefix that an object must have to be included in the inventory - results. - required: - - Prefix - description: Specifies an S3 Inventory filter. The inventory only includes objects - that meet the filter's criteria. - InventoryFormat: - type: string - enum: - - CSV - - ORC - - Parquet - InventoryFrequency: - type: string - enum: - - Daily - - Weekly - InventoryId: - type: string - InventoryIncludedObjectVersions: - type: string - enum: - - All - - Current - InventoryOptionalField: - type: string - enum: - - Size - - LastModifiedDate - - StorageClass - - ETag - - IsMultipartUploaded - - ReplicationStatus - - EncryptionStatus - - ObjectLockRetainUntilDate - - ObjectLockMode - - ObjectLockLegalHoldStatus - - IntelligentTieringAccessTier - - BucketKeyStatus - - ChecksumAlgorithm - - ObjectAccessControlList - - ObjectOwner - InventoryOptionalFields: - type: array - items: - $ref: '#/components/schemas/InventoryOptionalField' - InventoryS3BucketDestination: - type: object - properties: - AccountId: - $ref: '#/components/schemas/AccountId' - description: 'The account ID that owns the destination S3 bucket. If no - account ID is provided, the owner is not validated before exporting data. - - - Although this value is optional, we strongly recommend that you set it - to help prevent problems if the destination bucket ownership changes.' - Bucket: - $ref: '#/components/schemas/BucketName' - description: The Amazon Resource Name (ARN) of the bucket where inventory - results will be published. - Format: - $ref: '#/components/schemas/InventoryFormat' - description: Specifies the output format of the inventory results. - Prefix: - $ref: '#/components/schemas/Prefix' - description: The prefix that is prepended to all inventory results. - Encryption: - $ref: '#/components/schemas/InventoryEncryption' - description: Contains the type of server-side encryption used to encrypt - the inventory results. - required: - - Bucket - - Format - description: Contains the bucket name, file format, bucket owner (optional), - and prefix (optional) where S3 Inventory results are published. - InventorySchedule: - type: object - properties: - Frequency: - $ref: '#/components/schemas/InventoryFrequency' - description: Specifies how frequently inventory results are produced. - required: - - Frequency - description: Specifies the schedule for generating S3 Inventory results. - InventoryTableConfiguration: - type: object - properties: - ConfigurationState: - $ref: '#/components/schemas/InventoryConfigurationState' - description: The configuration state of the inventory table, indicating - whether the inventory table is enabled or disabled. - EncryptionConfiguration: - $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' - description: The encryption configuration for the inventory table. - required: - - ConfigurationState - description: The inventory table configuration for an S3 Metadata configuration. - InventoryTableConfigurationResult: - type: object - properties: - ConfigurationState: - $ref: '#/components/schemas/InventoryConfigurationState' - description: The configuration state of the inventory table, indicating - whether the inventory table is enabled or disabled. - TableStatus: - $ref: '#/components/schemas/MetadataTableStatus' - description: "The status of the inventory table. The status values are:\n\ - \n * `CREATING` \\- The inventory table is in the process of being created\ - \ in the specified Amazon Web Services managed table bucket.\n\n * `BACKFILLING`\ - \ \\- The inventory table is in the process of being backfilled. When\ - \ you enable the inventory table for your metadata configuration, the\ - \ table goes through a process known as backfilling, during which Amazon\ - \ S3 scans your general purpose bucket to retrieve the initial metadata\ - \ for all objects in the bucket. Depending on the number of objects in\ - \ your bucket, this process can take several hours. When the backfilling\ - \ process is finished, the status of your inventory table changes from\ - \ `BACKFILLING` to `ACTIVE`. After backfilling is completed, updates to\ - \ your objects are reflected in the inventory table within one hour.\n\ - \n * `ACTIVE` \\- The inventory table has been created successfully,\ - \ and records are being delivered to the table. \n\n * `FAILED` \\- Amazon\ - \ S3 is unable to create the inventory table, or Amazon S3 is unable to\ - \ deliver records." - Error: - $ref: '#/components/schemas/ErrorDetails' - TableName: - $ref: '#/components/schemas/S3TablesName' - description: The name of the inventory table. - TableArn: - $ref: '#/components/schemas/S3TablesArn' - description: The Amazon Resource Name (ARN) for the inventory table. - required: - - ConfigurationState - description: The inventory table configuration for an S3 Metadata configuration. - InventoryTableConfigurationUpdates: - type: object - properties: - ConfigurationState: - $ref: '#/components/schemas/InventoryConfigurationState' - description: The configuration state of the inventory table, indicating - whether the inventory table is enabled or disabled. - EncryptionConfiguration: - $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' - description: The encryption configuration for the inventory table. - required: - - ConfigurationState - description: The specified updates to the S3 Metadata inventory table configuration. - IsEnabled: - type: boolean - IsLatest: - type: boolean - IsPublic: - type: boolean - IsRestoreInProgress: - type: boolean - IsTruncated: - type: boolean - JSONInput: - type: object - properties: - Type: - $ref: '#/components/schemas/JSONType' - description: 'The type of JSON. Valid values: Document, Lines.' - description: Specifies JSON as object's input serialization format. - JSONOutput: - type: object - properties: - RecordDelimiter: - $ref: '#/components/schemas/RecordDelimiter' - description: The value used to separate individual records in the output. - If no value is specified, Amazon S3 uses a newline character ('\n'). - description: Specifies JSON as request's output serialization format. - JSONType: - type: string - enum: - - DOCUMENT - - LINES - JournalTableConfiguration: - type: object - properties: - RecordExpiration: - $ref: '#/components/schemas/RecordExpiration' - description: The journal table record expiration settings for the journal - table. - EncryptionConfiguration: - $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' - description: The encryption configuration for the journal table. - required: - - RecordExpiration - description: The journal table configuration for an S3 Metadata configuration. - JournalTableConfigurationResult: - type: object - properties: - TableStatus: - $ref: '#/components/schemas/MetadataTableStatus' - description: "The status of the journal table. The status values are:\n\n\ - \ * `CREATING` \\- The journal table is in the process of being created\ - \ in the specified table bucket.\n\n * `ACTIVE` \\- The journal table\ - \ has been created successfully, and records are being delivered to the\ - \ table. \n\n * `FAILED` \\- Amazon S3 is unable to create the journal\ - \ table, or Amazon S3 is unable to deliver records." - Error: - $ref: '#/components/schemas/ErrorDetails' - TableName: - $ref: '#/components/schemas/S3TablesName' - description: The name of the journal table. - TableArn: - $ref: '#/components/schemas/S3TablesArn' - description: The Amazon Resource Name (ARN) for the journal table. - RecordExpiration: - $ref: '#/components/schemas/RecordExpiration' - description: The journal table record expiration settings for the journal - table. - required: - - TableStatus - - TableName - - RecordExpiration - description: The journal table configuration for the S3 Metadata configuration. - JournalTableConfigurationUpdates: - type: object - properties: - RecordExpiration: - $ref: '#/components/schemas/RecordExpiration' - description: The journal table record expiration settings for the journal - table. - required: - - RecordExpiration - description: The specified updates to the S3 Metadata journal table configuration. - KMSContext: - type: string - KeyCount: - type: integer - KeyMarker: - type: string - KeyPrefixEquals: - type: string - KmsKeyArn: - type: string - LambdaFunctionArn: - type: string - LambdaFunctionConfiguration: - type: object - properties: - Id: - $ref: '#/components/schemas/NotificationId' - LambdaFunctionArn: - $ref: '#/components/schemas/LambdaFunctionArn' - description: The Amazon Resource Name (ARN) of the Lambda function that - Amazon S3 invokes when the specified event type occurs. - Events: - $ref: '#/components/schemas/EventList' - description: The Amazon S3 bucket event for which to invoke the Lambda function. - For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) - in the _Amazon S3 User Guide_. - Filter: - $ref: '#/components/schemas/NotificationConfigurationFilter' - required: - - LambdaFunctionArn - - Events - description: A container for specifying the configuration for Lambda notifications. - LambdaFunctionConfigurationList: - type: array - items: - $ref: '#/components/schemas/LambdaFunctionConfiguration' - LastModified: - type: string - format: date-time - LastModifiedTime: - type: string - format: date-time - LifecycleExpiration: - type: object - properties: - Date: - $ref: '#/components/schemas/Date' - description: 'Indicates at what date the object is to be moved or deleted. - The date value must conform to the ISO 8601 format. The time is always - midnight UTC. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - Days: - $ref: '#/components/schemas/Days' - description: Indicates the lifetime, in days, of the objects that are subject - to the rule. The value must be a non-zero positive integer. - ExpiredObjectDeleteMarker: - $ref: '#/components/schemas/ExpiredObjectDeleteMarker' - description: 'Indicates whether Amazon S3 will remove a delete marker with - no noncurrent versions. If set to true, the delete marker will be expired; - if set to false the policy takes no action. This cannot be specified with - Days or Date in a Lifecycle Expiration Policy. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - description: 'Container for the expiration for the lifecycle of the object. - - - For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) - in the _Amazon S3 User Guide_.' - LifecycleRule: - type: object - properties: - Expiration: - $ref: '#/components/schemas/LifecycleExpiration' - description: Specifies the expiration for the lifecycle of the object in - the form of date, days and, whether the object has a delete marker. - ID: - $ref: '#/components/schemas/ID' - description: Unique identifier for the rule. The value cannot be longer - than 255 characters. - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'The general purpose bucket prefix that identifies one or more - objects to which the rule applies. We recommend using `Filter` instead - of `Prefix` for new PUTs. Previous configurations where a prefix is defined - will continue to operate as before. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - Filter: - $ref: '#/components/schemas/LifecycleRuleFilter' - description: 'The `Filter` is used to identify objects that a Lifecycle - Rule applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, - `ObjectSizeGreaterThan`, `ObjectSizeLessThan`, or `And` specified. `Filter` - is required if the `LifecycleRule` does not contain a `Prefix` element. - - - For more information about `Tag` filters, see [Adding filters to Lifecycle - rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-filters.html) - in the _Amazon S3 User Guide_. - - - `Tag` filters are not supported for directory buckets.' - Status: - $ref: '#/components/schemas/ExpirationStatus' - description: If 'Enabled', the rule is currently being applied. If 'Disabled', - the rule is not currently being applied. - Transitions: - $ref: '#/components/schemas/TransitionList' - description: 'Specifies when an Amazon S3 object transitions to a specified - storage class. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - NoncurrentVersionTransitions: - $ref: '#/components/schemas/NoncurrentVersionTransitionList' - description: 'Specifies the transition rule for the lifecycle rule that - describes when noncurrent objects transition to a specific storage class. - If your bucket is versioning-enabled (or versioning is suspended), you - can set this action to request that Amazon S3 transition noncurrent object - versions to a specific storage class at a set period in the object''s - lifetime. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - NoncurrentVersionExpiration: - $ref: '#/components/schemas/NoncurrentVersionExpiration' - AbortIncompleteMultipartUpload: - $ref: '#/components/schemas/AbortIncompleteMultipartUpload' - required: - - Status - description: 'A lifecycle rule for individual objects in an Amazon S3 bucket. - - - For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) - in the _Amazon S3 User Guide_.' - LifecycleRuleAndOperator: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: Prefix identifying one or more objects to which the rule applies. - Tags: - $ref: '#/components/schemas/TagSet' - description: All of these tags must exist in the object's tag set in order - for the rule to apply. - ObjectSizeGreaterThan: - $ref: '#/components/schemas/ObjectSizeGreaterThanBytes' - description: Minimum object size to which the rule applies. - ObjectSizeLessThan: - $ref: '#/components/schemas/ObjectSizeLessThanBytes' - description: Maximum object size to which the rule applies. - description: This is used in a Lifecycle Rule Filter to apply a logical AND - to two or more predicates. The Lifecycle Rule will apply to any object matching - all of the predicates configured inside the And operator. - LifecycleRuleFilter: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'Prefix identifying one or more objects to which the rule applies. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - Tag: - $ref: '#/components/schemas/Tag' - description: 'This tag must exist in the object''s tag set in order for - the rule to apply. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - ObjectSizeGreaterThan: - $ref: '#/components/schemas/ObjectSizeGreaterThanBytes' - description: Minimum object size to which the rule applies. - ObjectSizeLessThan: - $ref: '#/components/schemas/ObjectSizeLessThanBytes' - description: Maximum object size to which the rule applies. - And: - $ref: '#/components/schemas/LifecycleRuleAndOperator' - description: The `Filter` is used to identify objects that a Lifecycle Rule - applies to. A `Filter` can have exactly one of `Prefix`, `Tag`, `ObjectSizeGreaterThan`, - `ObjectSizeLessThan`, or `And` specified. If the `Filter` element is left - empty, the Lifecycle Rule applies to all objects in the bucket. - LifecycleRules: - type: array - items: - $ref: '#/components/schemas/LifecycleRule' - ListBucketAnalyticsConfigurationsOutput: - type: object - properties: - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Indicates whether the returned list of analytics configurations - is complete. A value of true indicates that the list is not complete and - the NextContinuationToken will be provided for a subsequent request. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The marker that is used as a starting point for this analytics - configuration list response. This value is present if it was sent in the - request. - NextContinuationToken: - $ref: '#/components/schemas/NextToken' - description: '`NextContinuationToken` is sent when `isTruncated` is true, - which indicates that there are more analytics configurations to list. - The next request must include this `NextContinuationToken`. The token - is obfuscated and is not a usable value.' - AnalyticsConfigurationList: - $ref: '#/components/schemas/AnalyticsConfigurationList' - description: The list of analytics configurations for a bucket. - ListBucketAnalyticsConfigurationsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket from which analytics configurations - are retrieved. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The `ContinuationToken` that represents a placeholder from - where this request should begin. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - ListBucketIntelligentTieringConfigurationsOutput: - type: object - properties: - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Indicates whether the returned list of analytics configurations - is complete. A value of `true` indicates that the list is not complete - and the `NextContinuationToken` will be provided for a subsequent request. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The `ContinuationToken` that represents a placeholder from - where this request should begin. - NextContinuationToken: - $ref: '#/components/schemas/NextToken' - description: The marker used to continue this inventory configuration listing. - Use the `NextContinuationToken` from this response to continue the listing - in a subsequent request. The continuation token is an opaque value that - Amazon S3 understands. - IntelligentTieringConfigurationList: - $ref: '#/components/schemas/IntelligentTieringConfigurationList' - description: The list of S3 Intelligent-Tiering configurations for a bucket. - ListBucketIntelligentTieringConfigurationsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose configuration you want - to modify or retrieve. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The `ContinuationToken` that represents a placeholder from - where this request should begin. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - ListBucketInventoryConfigurationsOutput: - type: object - properties: - ContinuationToken: - $ref: '#/components/schemas/Token' - description: If sent in the request, the marker that is used as a starting - point for this inventory configuration list response. - InventoryConfigurationList: - $ref: '#/components/schemas/InventoryConfigurationList' - description: The list of inventory configurations for a bucket. - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Tells whether the returned list of inventory configurations - is complete. A value of true indicates that the list is not complete and - the NextContinuationToken is provided for a subsequent request. - NextContinuationToken: - $ref: '#/components/schemas/NextToken' - description: The marker used to continue this inventory configuration listing. - Use the `NextContinuationToken` from this response to continue the listing - in a subsequent request. The continuation token is an opaque value that - Amazon S3 understands. - ListBucketInventoryConfigurationsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the inventory configurations - to retrieve. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The marker used to continue an inventory configuration listing - that has been truncated. Use the `NextContinuationToken` from a previously - truncated list response to continue the listing. The continuation token - is an opaque value that Amazon S3 understands. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - ListBucketMetricsConfigurationsOutput: - type: object - properties: - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Indicates whether the returned list of metrics configurations - is complete. A value of true indicates that the list is not complete and - the NextContinuationToken will be provided for a subsequent request. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The marker that is used as a starting point for this metrics - configuration list response. This value is present if it was sent in the - request. - NextContinuationToken: - $ref: '#/components/schemas/NextToken' - description: The marker used to continue a metrics configuration listing - that has been truncated. Use the `NextContinuationToken` from a previously - truncated list response to continue the listing. The continuation token - is an opaque value that Amazon S3 understands. - MetricsConfigurationList: - $ref: '#/components/schemas/MetricsConfigurationList' - description: The list of metrics configurations for a bucket. - ListBucketMetricsConfigurationsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket containing the metrics configurations - to retrieve. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: The marker that is used to continue a metrics configuration - listing that has been truncated. Use the `NextContinuationToken` from - a previously truncated list response to continue the listing. The continuation - token is an opaque value that Amazon S3 understands. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - ListBucketsOutput: - type: object - properties: - Buckets: - type: array - items: - allOf: - - $ref: "#/components/schemas/Bucket" - - xml: - name: Bucket - Owner: - $ref: '#/components/schemas/Owner' - description: The owner of the buckets listed. - ContinuationToken: - $ref: '#/components/schemas/NextToken' - description: '`ContinuationToken` is included in the response when there - are more buckets that can be listed with pagination. The next `ListBuckets` - request to Amazon S3 can be continued with this `ContinuationToken`. `ContinuationToken` - is obfuscated and is not a real bucket.' - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'If `Prefix` was sent with the request, it is included in the - response. - - - All bucket names in the response begin with the specified bucket name - prefix.' - ListBucketsRequest: - type: object - properties: - MaxBuckets: - $ref: '#/components/schemas/MaxBuckets' - description: 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. - ContinuationToken: - $ref: '#/components/schemas/Token' - description: '`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. - - - Length Constraints: Minimum length of 0. Maximum length of 1024. - - - Required: No. - - - If you specify the `bucket-region`, `prefix`, or `continuation-token` - query parameters without using `max-buckets` to set the maximum number - of buckets returned in the response, Amazon S3 applies a default page - size of 10,000 and provides a continuation token if there are more buckets.' - Prefix: - $ref: '#/components/schemas/Prefix' - description: Limits the response to bucket names that begin with the specified - bucket name prefix. - BucketRegion: - $ref: '#/components/schemas/BucketRegion' - description: 'Limits the response to buckets that are located in the specified - Amazon Web Services Region. The Amazon Web Services Region must be expressed - according to the Amazon Web Services Region code, such as `us-west-2` - for the US West (Oregon) Region. For a list of the valid values for all - of the Amazon Web Services Regions, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). - - - Requests made to a Regional endpoint that is different from the `bucket-region` - parameter are not supported. For example, if you want to limit the response - to your buckets in Region `us-west-2`, the request must be made to an - endpoint in Region `us-west-2`.' - ListDirectoryBucketsOutput: - type: object - properties: - Buckets: - $ref: '#/components/schemas/Buckets' - description: The list of buckets owned by the requester. - ContinuationToken: - $ref: '#/components/schemas/DirectoryBucketToken' - description: 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: object - properties: - ContinuationToken: - $ref: '#/components/schemas/DirectoryBucketToken' - description: '`ContinuationToken` indicates to Amazon S3 that the list is - being continued on buckets in this account with a token. `ContinuationToken` - is obfuscated and is not a real bucket name. You can use this `ContinuationToken` - for the pagination of the list results.' - MaxDirectoryBuckets: - $ref: '#/components/schemas/MaxDirectoryBuckets' - description: 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. - ListMultipartUploadsOutput: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 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. - KeyMarker: - $ref: '#/components/schemas/KeyMarker' - description: The key at or after which the listing began. - UploadIdMarker: - $ref: '#/components/schemas/UploadIdMarker' - description: '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.' - NextKeyMarker: - $ref: '#/components/schemas/NextKeyMarker' - description: When a list is truncated, this element specifies the value - that should be used for the key-marker request parameter in a subsequent - request. - Prefix: - $ref: '#/components/schemas/Prefix' - description: '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: - $ref: '#/components/schemas/Delimiter' - description: '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: - $ref: '#/components/schemas/NextUploadIdMarker' - description: '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: - $ref: '#/components/schemas/MaxUploads' - description: Maximum number of multipart uploads that could have been included - in the response. - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Indicates whether the returned list of multipart uploads is - truncated. A value of true indicates that the list was truncated. The - list can be truncated if the number of multipart uploads exceeds the limit - allowed or specified by max uploads. - Uploads: - $ref: '#/components/schemas/MultipartUploadList' - description: Container for elements related to a particular multipart upload. - A response can contain zero or more `Upload` elements. - CommonPrefixes: - $ref: '#/components/schemas/CommonPrefixList' - description: '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: - $ref: '#/components/schemas/EncodingType' - description: 'Encoding type used by Amazon S3 to encode object keys in the - response. - - - If you specify the `encoding-type` request parameter, Amazon S3 includes - this element in the response, and returns encoded key name values in the - following response elements: - - - `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ListMultipartUploadsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: '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. - - - `CommonPrefixes` is filtered out from results if it is not lexicographically - greater than the key-marker. - - - **Directory buckets** \- For directory buckets, `/` is the only supported - delimiter.' - EncodingType: - $ref: '#/components/schemas/EncodingType' - KeyMarker: - $ref: '#/components/schemas/KeyMarker' - description: "Specifies the multipart upload after which listing should\ - \ begin.\n\n * **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.\n\nIf `upload-id-marker` is not specified, only the keys lexicographically\ - \ greater than the specified `key-marker` will be included in the list.\n\ - \nIf `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`.\n\n * **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. \n\nIn the `ListMultipartUploads`\ - \ response, the multipart uploads aren't sorted lexicographically based\ - \ on the object keys." - MaxUploads: - $ref: '#/components/schemas/MaxUploads' - description: Sets the maximum number of multipart uploads, from 1 to 1,000, - to return in the response body. 1,000 is the maximum number of uploads - that can be returned in a response. - Prefix: - $ref: '#/components/schemas/Prefix' - description: '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.' - UploadIdMarker: - $ref: '#/components/schemas/UploadIdMarker' - description: '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.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - required: - - Bucket - ListObjectVersionsOutput: - type: object - properties: - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: A flag that indicates whether Amazon S3 returned all of the - results that satisfied the search criteria. If your results were truncated, - you can make a follow-up paginated request by using the `NextKeyMarker` - and `NextVersionIdMarker` response parameters as a starting place in another - request to return the rest of the results. - KeyMarker: - $ref: '#/components/schemas/KeyMarker' - description: Marks the last key returned in a truncated response. - VersionIdMarker: - $ref: '#/components/schemas/VersionIdMarker' - description: Marks the last version of the key returned in a truncated response. - NextKeyMarker: - $ref: '#/components/schemas/NextKeyMarker' - description: When the number of responses exceeds the value of `MaxKeys`, - `NextKeyMarker` specifies the first key not returned that satisfies the - search criteria. Use this value for the key-marker request parameter in - a subsequent request. - NextVersionIdMarker: - $ref: '#/components/schemas/NextVersionIdMarker' - description: When the number of responses exceeds the value of `MaxKeys`, - `NextVersionIdMarker` specifies the first object version not returned - that satisfies the search criteria. Use this value for the `version-id-marker` - request parameter in a subsequent request. - Versions: - $ref: '#/components/schemas/ObjectVersionList' - description: Container for version information. - DeleteMarkers: - $ref: '#/components/schemas/DeleteMarkers' - description: Container for an object that is a delete marker. To learn more - about delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). - Name: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - Prefix: - $ref: '#/components/schemas/Prefix' - description: Selects objects that start with the value supplied by this - parameter. - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: The delimiter grouping the included keys. A delimiter is a - character that you specify to group keys. All keys that contain the same - string between the prefix and the first occurrence of the delimiter are - grouped under a single result element in `CommonPrefixes`. These groups - are counted as one result against the `max-keys` limitation. These keys - are not returned elsewhere in the response. - MaxKeys: - $ref: '#/components/schemas/MaxKeys' - description: Specifies the maximum number of objects to return. - CommonPrefixes: - $ref: '#/components/schemas/CommonPrefixList' - description: All of the keys rolled up into a common prefix count as a single - return when calculating the number of returns. - EncodingType: - $ref: '#/components/schemas/EncodingType' - description: 'Encoding type used by Amazon S3 to encode object key names - in the XML response. - - - If you specify the `encoding-type` request parameter, Amazon S3 includes - this element in the response, and returns encoded key name values in the - following response elements: - - - `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ListObjectVersionsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name that contains the objects. - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: 'A delimiter is a character that you specify to group keys. - All keys that contain the same string between the `prefix` and the first - occurrence of the delimiter are grouped under a single result element - in `CommonPrefixes`. These groups are counted as one result against the - `max-keys` limitation. These keys are not returned elsewhere in the response. - - - `CommonPrefixes` is filtered out from results if it is not lexicographically - greater than the key-marker.' - EncodingType: - $ref: '#/components/schemas/EncodingType' - KeyMarker: - $ref: '#/components/schemas/KeyMarker' - description: Specifies the key to start with when listing objects in a bucket. - MaxKeys: - $ref: '#/components/schemas/MaxKeys' - description: Sets the maximum number of keys returned in the response. By - default, the action returns up to 1,000 key names. The response might - contain fewer keys but will never contain more. If additional keys satisfy - the search criteria, but were not returned because `max-keys` was exceeded, - the response contains `true`. To return the additional keys, see `key-marker` - and `version-id-marker`. - Prefix: - $ref: '#/components/schemas/Prefix' - description: Use this parameter to select only those keys that begin with - the specified prefix. You can use prefixes to separate a bucket into different - groupings 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.) You can use `prefix` - with `delimiter` to roll up numerous objects into a single result under - `CommonPrefixes`. - VersionIdMarker: - $ref: '#/components/schemas/VersionIdMarker' - description: Specifies the object version you want to start listing from. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - OptionalObjectAttributes: - $ref: '#/components/schemas/OptionalObjectAttributesList' - description: Specifies the optional fields that you want returned in the - response. Fields that you do not specify are not returned. - required: - - Bucket - ListObjectsOutput: - type: object - properties: - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: A flag that indicates whether Amazon S3 returned all of the - results that satisfied the search criteria. - Marker: - $ref: '#/components/schemas/Marker' - description: Indicates where in the bucket listing begins. Marker is included - in the response if it was sent with the request. - NextMarker: - $ref: '#/components/schemas/NextMarker' - description: 'When the response is truncated (the `IsTruncated` element - value in the response is `true`), you can use the key name in this field - as the `marker` parameter in the subsequent request to get the next set - of objects. Amazon S3 lists objects in alphabetical order. - - - This element is returned only if you have the `delimiter` request parameter - specified. If the response does not include the `NextMarker` element and - it is truncated, you can use the value of the last `Key` element in the - response as the `marker` parameter in the subsequent request to get the - next set of object keys.' - Contents: - $ref: '#/components/schemas/ObjectList' - description: Metadata about each object returned. - Name: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - Prefix: - $ref: '#/components/schemas/Prefix' - description: Keys that begin with the indicated prefix. - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: 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. - MaxKeys: - $ref: '#/components/schemas/MaxKeys' - description: The maximum number of keys returned in the response body. - CommonPrefixes: - $ref: '#/components/schemas/CommonPrefixList' - description: 'All of the keys (up to 1,000) rolled up in 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 the 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.' - EncodingType: - $ref: '#/components/schemas/EncodingType' - description: 'Encoding type used by Amazon S3 to encode the [object keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html) - in the response. Responses are encoded only in UTF-8. An object key can - contain any Unicode character. However, the XML 1.0 parser can''t parse - certain characters, such as characters with an ASCII value from 0 to 10. - For characters that aren''t supported in XML 1.0, you can add this parameter - to request that Amazon S3 encode the keys in the response. For more information - about characters to avoid in object key names, see [Object key naming - guidelines](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines). - - - When using the URL encoding type, non-ASCII characters that are used in - an object''s key name will be percent-encoded according to UTF-8 code - values. For example, the object `test_file(3).png` will appear as `test_file%283%29.png`.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ListObjectsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: 'A delimiter is a character that you use to group keys. - - - `CommonPrefixes` is filtered out from results if it is not lexicographically - greater than the key-marker.' - EncodingType: - $ref: '#/components/schemas/EncodingType' - Marker: - $ref: '#/components/schemas/Marker' - description: Marker is where you want Amazon S3 to start listing from. Amazon - S3 starts listing after this specified key. Marker can be any key in the - bucket. - MaxKeys: - $ref: '#/components/schemas/MaxKeys' - description: Sets the maximum number of keys returned in the response. By - default, the action returns up to 1,000 key names. The response might - contain fewer keys but will never contain more. - Prefix: - $ref: '#/components/schemas/Prefix' - description: Limits the response to keys that begin with the specified prefix. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - description: Confirms that the requester knows that she or he will be charged - for the list objects request. Bucket owners need not specify this parameter - in their requests. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - OptionalObjectAttributes: - $ref: '#/components/schemas/OptionalObjectAttributesList' - description: Specifies the optional fields that you want returned in the - response. Fields that you do not specify are not returned. - required: - - Bucket - ListObjectsV2Output: - type: object - properties: - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Set to `false` if all of the results were returned. Set to - `true` if more keys are available to return. If the number of results - exceeds that specified by `MaxKeys`, all of the results might not be returned. - Contents: - $ref: '#/components/schemas/ObjectList' - description: Metadata about each object returned. - Name: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'Keys that begin with the indicated prefix. - - - **Directory buckets** \- For directory buckets, only prefixes that end - in a delimiter (`/`) are supported.' - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: '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: - $ref: '#/components/schemas/MaxKeys' - description: Sets the maximum number of keys returned in the response. By - default, the action returns up to 1,000 key names. The response might - contain fewer keys but will never contain more. - CommonPrefixes: - $ref: '#/components/schemas/CommonPrefixList' - description: "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.\n\nA response\ - \ can contain `CommonPrefixes` only if you specify a delimiter.\n\n`CommonPrefixes`\ - \ contains all (if there are any) keys between `Prefix` and the next occurrence\ - \ of the string specified by a delimiter.\n\n`CommonPrefixes` lists keys\ - \ that act like subdirectories in the directory specified by `Prefix`.\n\ - \nFor 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.\n\n * **Directory buckets**\ - \ \\- For directory buckets, only prefixes that end in a delimiter (`/`)\ - \ are supported.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\ - \ in the _Amazon S3 User Guide_." - EncodingType: - $ref: '#/components/schemas/EncodingType' - description: 'Encoding type used by Amazon S3 to encode object key names - in the XML response. - - - If you specify the `encoding-type` request parameter, Amazon S3 includes - this element in the response, and returns encoded key name values in the - following response elements: - - - `Delimiter, Prefix, Key,` and `StartAfter`.' - KeyCount: - $ref: '#/components/schemas/KeyCount' - description: '`KeyCount` is the number of keys returned with this request. - `KeyCount` will always be less than or equal to the `MaxKeys` field. For - example, if you ask for 50 keys, your result will include 50 keys or fewer.' - ContinuationToken: - $ref: '#/components/schemas/Token' - description: 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. - NextContinuationToken: - $ref: '#/components/schemas/NextToken' - description: '`NextContinuationToken` is sent when `isTruncated` is true, - which means there are more keys in the bucket that can be listed. The - next list requests to Amazon S3 can be continued with this `NextContinuationToken`. - `NextContinuationToken` is obfuscated and is not a real key' - StartAfter: - $ref: '#/components/schemas/StartAfter' - description: 'If StartAfter was sent with the request, it is included in - the response. - - - This functionality is not supported for directory buckets.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ListObjectsV2Request: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '**Directory buckets** \- When you use this operation with - a directory bucket, you must use virtual-hosted-style requests in the - format ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Delimiter: - $ref: '#/components/schemas/Delimiter' - description: "A delimiter is a character that you use to group keys.\n\n\ - `CommonPrefixes` is filtered out from results if it is not lexicographically\ - \ greater than the `StartAfter` value.\n\n * **Directory buckets** \\\ - - For directory buckets, `/` is the only supported delimiter.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\ - \ in the _Amazon S3 User Guide_." - EncodingType: - $ref: '#/components/schemas/EncodingType' - description: 'Encoding type used by Amazon S3 to encode the [object keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html) - in the response. Responses are encoded only in UTF-8. An object key can - contain any Unicode character. However, the XML 1.0 parser can''t parse - certain characters, such as characters with an ASCII value from 0 to 10. - For characters that aren''t supported in XML 1.0, you can add this parameter - to request that Amazon S3 encode the keys in the response. For more information - about characters to avoid in object key names, see [Object key naming - guidelines](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines). - - - When using the URL encoding type, non-ASCII characters that are used in - an object''s key name will be percent-encoded according to UTF-8 code - values. For example, the object `test_file(3).png` will appear as `test_file%283%29.png`.' - MaxKeys: - $ref: '#/components/schemas/MaxKeys' - description: Sets the maximum number of keys returned in the response. By - default, the action returns up to 1,000 key names. The response might - contain fewer keys but will never contain more. - Prefix: - $ref: '#/components/schemas/Prefix' - description: '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.' - ContinuationToken: - $ref: '#/components/schemas/Token' - description: '`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.' - FetchOwner: - $ref: '#/components/schemas/FetchOwner' - description: '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.' - StartAfter: - $ref: '#/components/schemas/StartAfter' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - description: '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.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - OptionalObjectAttributes: - $ref: '#/components/schemas/OptionalObjectAttributesList' - description: '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.' - required: - - Bucket - ListPartsOutput: - type: object - properties: - AbortDate: - $ref: '#/components/schemas/AbortDate' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). - - - 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.' - AbortRuleId: - $ref: '#/components/schemas/AbortRuleId' - description: '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.' - Bucket: - $ref: '#/components/schemas/BucketName' - description: 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. - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload was initiated. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: Upload ID identifying the multipart upload whose parts are - being listed. - PartNumberMarker: - $ref: '#/components/schemas/PartNumberMarker' - description: Specifies the part after which listing should begin. Only parts - with higher part numbers will be listed. - NextPartNumberMarker: - $ref: '#/components/schemas/NextPartNumberMarker' - description: When a list is truncated, this element specifies the last part - in the list, as well as the value to use for the `part-number-marker` - request parameter in a subsequent request. - MaxParts: - $ref: '#/components/schemas/MaxParts' - description: Maximum number of parts that were allowed in the response. - IsTruncated: - $ref: '#/components/schemas/IsTruncated' - description: Indicates whether the returned list of parts is truncated. - A true value indicates that the list was truncated. A list can be truncated - if the number of parts exceeds the limit returned in the MaxParts element. - Parts: - $ref: '#/components/schemas/Parts' - description: Container for elements related to a particular part. A response - can contain zero or more `Part` elements. - Initiator: - $ref: '#/components/schemas/Initiator' - description: Container element that identifies who initiated the multipart - upload. If the initiator is an Amazon Web Services account, this element - provides the same information as the `Owner` element. If the initiator - is an IAM User, this element provides the user ARN. - Owner: - $ref: '#/components/schemas/Owner' - description: '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. - - - **Directory buckets** \- The bucket owner is returned as the object owner - for all the parts.' - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: 'The class of storage used to store the uploaded object. - - - **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` - (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` - (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The algorithm that was used to create a checksum of the object. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type, which determines how part-level checksums - are combined to create an object-level checksum for multipart objects. - You can use this header response to verify that the checksum type that - is received is the same checksum type that was specified in `CreateMultipartUpload` - request. For more information, see [Checking object integrity in the Amazon - S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ListPartsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload was initiated. - MaxParts: - $ref: '#/components/schemas/MaxParts' - description: Sets the maximum number of parts to return. - PartNumberMarker: - $ref: '#/components/schemas/PartNumberMarker' - description: Specifies the part after which listing should begin. Only parts - with higher part numbers will be listed. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: Upload ID identifying the multipart upload whose parts are - being listed. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - required: - - Bucket - - Key - - UploadId - Location: - type: string - LocationInfo: - type: object - properties: - Type: - $ref: '#/components/schemas/LocationType' - description: The type of location where the bucket will be created. - Name: - $ref: '#/components/schemas/LocationNameAsString' - description: 'The name of the location where the bucket will be created. - - - For directory buckets, the name of the location is the Zone ID of the - Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. - An example AZ ID value is `usw2-az1`.' - description: 'Specifies the location where the bucket will be created. - - - For directory buckets, the location type is Availability Zone or Local Zone. - For more information about directory buckets, see [Working with directory - buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) - 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 - - LocalZone - LoggingEnabled: - type: object - properties: - TargetBucket: - $ref: '#/components/schemas/TargetBucket' - description: Specifies the bucket where you want Amazon S3 to store server - access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure - multiple buckets to deliver their logs to the same target bucket. In this - case, you should choose a different `TargetPrefix` for each source bucket - so that the delivered log files can be distinguished by key. - TargetGrants: - $ref: '#/components/schemas/TargetGrants' - description: 'Container for granting information. - - - Buckets that use the bucket owner enforced setting for Object Ownership - don''t support target grants. For more information, see [Permissions for - server access log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) - in the _Amazon S3 User Guide_.' - TargetPrefix: - $ref: '#/components/schemas/TargetPrefix' - description: A prefix for all log object keys. If you store log files from - multiple Amazon S3 buckets in a single bucket, you can use a prefix to - distinguish which log files came from which bucket. - TargetObjectKeyFormat: - $ref: '#/components/schemas/TargetObjectKeyFormat' - description: Amazon S3 key format for log objects. - required: - - TargetBucket - - TargetPrefix - description: Describes where logs are stored and the prefix that Amazon S3 assigns - to all log object keys for a bucket. For more information, see [PUT Bucket - logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) - in the _Amazon S3 API Reference_. - MFA: - type: string - MFADelete: - type: string - enum: - - Enabled - - Disabled - MFADeleteStatus: - type: string - enum: - - Enabled - - Disabled - Marker: - type: string - MaxAgeSeconds: - type: integer - MaxBuckets: - type: integer - minimum: 1 - maximum: 10000 - MaxDirectoryBuckets: - type: integer - minimum: 0 - maximum: 1000 - MaxKeys: - type: integer - MaxParts: - type: integer - MaxUploads: - type: integer - Message: - type: string - Metadata: - type: object - additionalProperties: - $ref: '#/components/schemas/metadatavalue' - MetadataConfiguration: - type: object - properties: - JournalTableConfiguration: - $ref: '#/components/schemas/JournalTableConfiguration' - description: The journal table configuration for a metadata configuration. - InventoryTableConfiguration: - $ref: '#/components/schemas/InventoryTableConfiguration' - description: The inventory table configuration for a metadata configuration. - required: - - JournalTableConfiguration - description: The S3 Metadata configuration for a general purpose bucket. - MetadataConfigurationResult: - type: object - properties: - DestinationResult: - $ref: '#/components/schemas/DestinationResult' - description: The destination settings for a metadata configuration. - JournalTableConfigurationResult: - $ref: '#/components/schemas/JournalTableConfigurationResult' - description: The journal table configuration for a metadata configuration. - InventoryTableConfigurationResult: - $ref: '#/components/schemas/InventoryTableConfigurationResult' - description: The inventory table configuration for a metadata configuration. - required: - - DestinationResult - description: The S3 Metadata configuration for a general purpose bucket. - MetadataDirective: - type: string - enum: - - COPY - - REPLACE - MetadataEntry: - type: object - properties: - Name: - $ref: '#/components/schemas/MetadataKey' - description: Name of the object. - Value: - $ref: '#/components/schemas/MetadataValue' - description: Value of the object. - description: A metadata key-value pair to store with an object. - MetadataKey: - type: string - MetadataTableConfiguration: - type: object - properties: - S3TablesDestination: - $ref: '#/components/schemas/S3TablesDestination' - description: The destination information for the metadata table configuration. - The destination table bucket must be in the same Region and Amazon Web - Services account as the general purpose bucket. The specified metadata - table name must be unique within the `aws_s3_metadata` namespace in the - destination table bucket. - required: - - S3TablesDestination - description: 'The V1 S3 Metadata configuration for a general purpose bucket. - - - If you created your S3 Metadata configuration before July 15, 2025, we recommend - that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) - so that you can expire journal table records and create a live inventory table.' - MetadataTableConfigurationResult: - type: object - properties: - S3TablesDestinationResult: - $ref: '#/components/schemas/S3TablesDestinationResult' - description: The destination information for the metadata table configuration. - The destination table bucket must be in the same Region and Amazon Web - Services account as the general purpose bucket. The specified metadata - table name must be unique within the `aws_s3_metadata` namespace in the - destination table bucket. - required: - - S3TablesDestinationResult - description: 'The V1 S3 Metadata configuration for a general purpose bucket. - The destination table bucket must be in the same Region and Amazon Web Services - account as the general purpose bucket. The specified metadata table name must - be unique within the `aws_s3_metadata` namespace in the destination table - bucket. - - - If you created your S3 Metadata configuration before July 15, 2025, we recommend - that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) - so that you can expire journal table records and create a live inventory table.' - MetadataTableEncryptionConfiguration: - type: object - properties: - SseAlgorithm: - $ref: '#/components/schemas/TableSseAlgorithm' - description: The encryption type specified for a metadata table. To specify - server-side encryption with Key Management Service (KMS) keys (SSE-KMS), - use the `aws:kms` value. To specify server-side encryption with Amazon - S3 managed keys (SSE-S3), use the `AES256` value. - KmsKeyArn: - $ref: '#/components/schemas/KmsKeyArn' - description: If server-side encryption with Key Management Service (KMS) - keys (SSE-KMS) is specified, you must also specify the KMS key Amazon - Resource Name (ARN). You must specify a customer-managed KMS key that's - located in the same Region as the general purpose bucket that corresponds - to the metadata table configuration. - required: - - SseAlgorithm - description: The encryption settings for an S3 Metadata journal table or inventory - table configuration. - MetadataTableStatus: - type: string - MetadataValue: - type: string - Metrics: - type: object - properties: - Status: - $ref: '#/components/schemas/MetricsStatus' - description: Specifies whether the replication metrics are enabled. - EventThreshold: - $ref: '#/components/schemas/ReplicationTimeValue' - description: A container specifying the time threshold for emitting the - `s3:Replication:OperationMissedThreshold` event. - required: - - Status - description: A container specifying replication metrics-related settings enabling - replication metrics and events. - MetricsAndOperator: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: The prefix used when evaluating an AND predicate. - Tags: - $ref: '#/components/schemas/TagSet' - description: The list of tags used when evaluating an AND predicate. - AccessPointArn: - $ref: '#/components/schemas/AccessPointArn' - description: The access point ARN used when evaluating an `AND` predicate. - description: A conjunction (logical AND) of predicates, which is used in evaluating - a metrics filter. The operator must have at least two predicates, and an object - must match all of the predicates in order for the filter to apply. - MetricsConfiguration: - type: object - properties: - Id: - $ref: '#/components/schemas/MetricsId' - description: The ID used to identify the metrics configuration. The ID has - a 64 character limit and can only contain letters, numbers, periods, dashes, - and underscores. - Filter: - $ref: '#/components/schemas/MetricsFilter' - description: Specifies a metrics configuration filter. The metrics configuration - will only include objects that meet the filter's criteria. A filter must - be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). - required: - - Id - description: Specifies a metrics configuration for the CloudWatch request metrics - (specified by the metrics configuration ID) from an Amazon S3 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. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). - MetricsConfigurationList: - type: array - items: - $ref: '#/components/schemas/MetricsConfiguration' - MetricsFilter: - allOf: - - $ref: '#/components/schemas/Prefix' - description: |- - The prefix used when evaluating a metrics filter. - - $ref: '#/components/schemas/Tag' - description: |- - The tag used when evaluating a metrics filter. - - $ref: '#/components/schemas/AccessPointArn' - description: |- - The access point ARN used when evaluating a metrics filter. - - $ref: '#/components/schemas/MetricsAndOperator' - description: |- - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply. - description: |- - Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html). - MetricsId: - type: string - MetricsStatus: - type: string - enum: - - Enabled - - Disabled - Minutes: - type: integer - MissingMeta: - type: integer - MpuObjectSize: - type: integer - format: int64 - MultipartUpload: - type: object - properties: - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: Upload ID that identifies the multipart upload. - Key: - $ref: '#/components/schemas/ObjectKey' - description: Key of the object for which the multipart upload was initiated. - Initiated: - $ref: '#/components/schemas/Initiated' - description: Date and time at which the multipart upload was initiated. - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: 'The class of storage used to store the object. - - - **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` - (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` - (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' - Owner: - $ref: '#/components/schemas/Owner' - description: '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: - $ref: '#/components/schemas/Initiator' - description: Identifies who initiated the multipart upload. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The algorithm that was used to create a checksum of the object. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type that is used to calculate the object’s checksum - value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - description: Container for the `MultipartUpload` for the Amazon S3 object. - MultipartUploadId: - type: string - MultipartUploadList: - type: array - items: - $ref: '#/components/schemas/MultipartUpload' - NextKeyMarker: - type: string - NextMarker: - type: string - NextPartNumberMarker: - type: string - NextToken: - type: string - NextUploadIdMarker: - type: string - NextVersionIdMarker: - type: string - NoSuchBucket: - type: object - properties: {} - description: The specified bucket does not exist. - NoSuchKey: - type: object - properties: {} - description: The specified key does not exist. - NoSuchUpload: - type: object - properties: {} - description: The specified multipart upload does not exist. - NoncurrentVersionExpiration: - type: object - properties: - NoncurrentDays: - $ref: '#/components/schemas/Days' - description: 'Specifies the number of days an object is noncurrent before - Amazon S3 can perform the associated action. The value must be a non-zero - positive integer. For information about the noncurrent days calculations, - see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) - in the _Amazon S3 User Guide_. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - NewerNoncurrentVersions: - $ref: '#/components/schemas/VersionCount' - description: 'Specifies how many noncurrent versions Amazon S3 will retain. - You can specify up to 100 noncurrent versions to retain. Amazon S3 will - permanently delete any additional noncurrent versions beyond the specified - number to retain. For more information about noncurrent versions, see - [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) - in the _Amazon S3 User Guide_. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - description: 'Specifies when noncurrent object versions expire. Upon expiration, - Amazon S3 permanently deletes the noncurrent object versions. You set this - lifecycle configuration action on a bucket that has versioning enabled (or - suspended) to request that Amazon S3 delete noncurrent object versions at - a specific period in the object''s lifetime. - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - NoncurrentVersionTransition: - type: object - properties: - NoncurrentDays: - $ref: '#/components/schemas/Days' - description: Specifies the number of days an object is noncurrent before - Amazon S3 can perform the associated action. For information about the - noncurrent days calculations, see [How Amazon S3 Calculates How Long an - Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) - in the _Amazon S3 User Guide_. - StorageClass: - $ref: '#/components/schemas/TransitionStorageClass' - description: The class of storage used to store the object. - NewerNoncurrentVersions: - $ref: '#/components/schemas/VersionCount' - description: Specifies how many noncurrent versions Amazon S3 will retain - in the same storage class before transitioning objects. You can specify - up to 100 noncurrent versions to retain. Amazon S3 will transition any - additional noncurrent versions beyond the specified number to retain. - For more information about noncurrent versions, see [Lifecycle configuration - elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) - in the _Amazon S3 User Guide_. - description: Container for the transition rule that describes when noncurrent - objects transition to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, - `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class. If your bucket is - versioning-enabled (or versioning is suspended), you can set this action to - request that Amazon S3 transition noncurrent object versions to the `STANDARD_IA`, - `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` - storage class at a specific period in the object's lifetime. - NoncurrentVersionTransitionList: - type: array - items: - $ref: '#/components/schemas/NoncurrentVersionTransition' - NotFound: - type: object - properties: {} - description: The specified content does not exist. - NotificationConfiguration: - type: object - properties: - TopicConfigurations: - $ref: '#/components/schemas/TopicConfigurationList' - description: The topic to which notifications are sent and the events for - which notifications are generated. - QueueConfigurations: - $ref: '#/components/schemas/QueueConfigurationList' - description: The Amazon Simple Queue Service queues to publish messages - to and the events for which to publish messages. - LambdaFunctionConfigurations: - $ref: '#/components/schemas/LambdaFunctionConfigurationList' - description: Describes the Lambda functions to invoke and the events for - which to invoke them. - EventBridgeConfiguration: - $ref: '#/components/schemas/EventBridgeConfiguration' - description: Enables delivery of events to Amazon EventBridge. - description: A container for specifying the notification configuration of the - bucket. If this element is empty, notifications are turned off for the bucket. - NotificationConfigurationFilter: - type: object - properties: - Key: - $ref: '#/components/schemas/S3KeyFilter' - description: Specifies object key name filtering rules. For information about - key name filtering, see [Configuring event notifications using object key - name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) - in the _Amazon S3 User Guide_. - NotificationId: - type: string - Object: - type: object - properties: - Key: - $ref: '#/components/schemas/ObjectKey' - description: The name that you assign to an object. You use the object key - to retrieve the object. - LastModified: - $ref: '#/components/schemas/LastModified' - description: Creation date of the object. - ETag: - $ref: '#/components/schemas/ETag' - description: "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:\n\n * 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.\n\n * 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.\n\n * 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.\n\n**Directory buckets** \\- MD5 is\ - \ not supported by directory buckets." - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithmList' - description: The algorithm that was used to create a checksum of the object. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type that is used to calculate the object’s checksum - value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - Size: - $ref: '#/components/schemas/Size' - description: Size in bytes of the object - StorageClass: - $ref: '#/components/schemas/ObjectStorageClass' - description: 'The class of storage used to store the object. - - - **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` - (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` - (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' - Owner: - $ref: '#/components/schemas/Owner' - description: 'The owner of the object - - - **Directory buckets** \- The bucket owner is returned as the object owner.' - RestoreStatus: - $ref: '#/components/schemas/RestoreStatus' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets. Directory buckets - only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) - in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access - storage class) in Dedicated Local Zones.' - description: An object consists of data and its descriptive metadata. - ObjectAlreadyInActiveTierError: - type: object - properties: {} - description: This action is not allowed against this storage tier. - ObjectAttributes: - type: string - enum: - - ETag - - Checksum - - ObjectParts - - StorageClass - - ObjectSize - ObjectAttributesList: - type: array - items: - $ref: '#/components/schemas/ObjectAttributes' - ObjectCannedACL: - type: string - enum: - - private - - public-read - - public-read-write - - authenticated-read - - aws-exec-read - - bucket-owner-read - - bucket-owner-full-control - ObjectIdentifier: - type: object - properties: - Key: - $ref: '#/components/schemas/ObjectKey' - description: 'Key name of the object. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID for the specific version of the object to delete. - - - This functionality is not supported for directory buckets.' - ETag: - $ref: '#/components/schemas/ETag' - description: 'An entity tag (ETag) is an identifier assigned by a web server - to a specific version of a resource found at a URL. This header field - makes the request method conditional on `ETags`. - - - Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings - unique to the object.' - LastModifiedTime: - $ref: '#/components/schemas/LastModifiedTime' - description: 'If present, the objects are deleted only if its modification - times matches the provided `Timestamp`. - - - This functionality is only supported for directory buckets.' - Size: - $ref: '#/components/schemas/Size' - description: 'If present, the objects are deleted only if its size matches - the provided size in bytes. - - - This functionality is only supported for directory buckets.' - required: - - Key - description: Object Identifier is unique value to identify objects. - ObjectIdentifierList: - type: array - items: - $ref: '#/components/schemas/ObjectIdentifier' - ObjectKey: - type: string - minLength: 1 - ObjectList: - type: array - items: - $ref: '#/components/schemas/Object' - ObjectLockConfiguration: - type: object - properties: - ObjectLockEnabled: - $ref: '#/components/schemas/ObjectLockEnabled' - description: Indicates whether this bucket has an Object Lock configuration - enabled. Enable `ObjectLockEnabled` when you apply `ObjectLockConfiguration` - to a bucket. - Rule: - $ref: '#/components/schemas/ObjectLockRule' - description: Specifies the Object Lock rule for the specified object. Enable - the this rule when you apply `ObjectLockConfiguration` to a bucket. Bucket - settings require both a mode and a period. The period can be either `Days` - or `Years` but you must select one. You cannot specify `Days` and `Years` - at the same time. - description: The container element for Object Lock configuration parameters. - ObjectLockEnabled: - type: string - enum: - - Enabled - ObjectLockEnabledForBucket: - type: boolean - ObjectLockLegalHold: - type: object - properties: - Status: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: Indicates whether the specified object has a legal hold in - place. - description: A legal hold configuration for an object. - ObjectLockLegalHoldStatus: - type: string - enum: - - 'ON' - - 'OFF' - ObjectLockMode: - type: string - enum: - - GOVERNANCE - - COMPLIANCE - ObjectLockRetainUntilDate: - type: string - format: date-time - ObjectLockRetention: - type: object - properties: - Mode: - $ref: '#/components/schemas/ObjectLockRetentionMode' - description: Indicates the Retention mode for the specified object. - RetainUntilDate: - $ref: '#/components/schemas/Date' - description: The date on which this Object Lock Retention will expire. - description: A Retention configuration for an object. - ObjectLockRetentionMode: - type: string - enum: - - GOVERNANCE - - COMPLIANCE - ObjectLockRule: - type: object - properties: - DefaultRetention: - $ref: '#/components/schemas/DefaultRetention' - description: The default Object Lock retention mode and period that you - want to apply to new objects placed in the specified bucket. Bucket settings - require both a mode and a period. The period can be either `Days` or `Years` - but you must select one. You cannot specify `Days` and `Years` at the - same time. - description: The container element for an Object Lock rule. - ObjectLockToken: - type: string - ObjectNotInActiveTierError: - type: object - properties: {} - description: The source object of the COPY action is not in the active tier - and is only stored in Amazon S3 Glacier. - ObjectOwnership: - type: string - enum: - - BucketOwnerPreferred - - ObjectWriter - - BucketOwnerEnforced - description: "

The container element for object ownership for a bucket's ownership\ - \ controls.

\n

\n BucketOwnerPreferred\ - \ - Objects uploaded to the bucket change ownership to the bucket\n owner\ - \ if the objects are uploaded with the bucket-owner-full-control\ - \ canned ACL.

\n

\n ObjectWriter - The\ - \ uploading account will own the object if the object is uploaded with\n \ - \ the bucket-owner-full-control canned ACL.

\n \ - \

\n BucketOwnerEnforced - Access control lists\ - \ (ACLs) are disabled and no longer affect\n permissions. The bucket\ - \ owner automatically owns and has full control over every object in the bucket.\n\ - \ The bucket only accepts PUT requests that don't specify an ACL or specify\ - \ bucket owner full control ACLs\n (such as the predefined bucket-owner-full-control\ - \ canned ACL or a custom ACL in XML format\n that grants the same permissions).

\n\ - \

By default, ObjectOwnership is set to BucketOwnerEnforced\ - \ and ACLs are\n disabled. We recommend keeping ACLs disabled, except\ - \ in uncommon use cases where you must control access\n for each object\ - \ individually. For more information about S3 Object Ownership, see Controlling\n ownership of objects and disabling ACLs for your bucket\ - \ in the\n Amazon S3 User Guide.

\n \n \ - \

This functionality is not supported for directory buckets. Directory\ - \ buckets use the bucket owner enforced setting for S3 Object Ownership.

\n\ - \ " - ObjectPart: - type: object - properties: - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: The part number identifying the part. This value is a positive - integer between 1 and 10,000. - Size: - $ref: '#/components/schemas/Size' - description: The size of the uploaded part in bytes. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32` checksum of the part. This - checksum is present if the multipart upload request was created with the - `CRC32` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the part. This - checksum is present if the multipart upload request was created with the - `CRC32C` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. - This checksum is present if the multipart upload request was created with - the `CRC64NVME` checksum algorithm, or if the object was uploaded without - a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to - the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` checksum of the part. This - checksum is present if the multipart upload request was created with the - `SHA1` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` checksum of the part. - This checksum is present if the multipart upload request was created with - the `SHA256` checksum algorithm. For more information, see [Checking object - integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - description: A container for elements related to an individual part. - ObjectSize: - type: integer - format: int64 - ObjectSizeGreaterThanBytes: - type: integer - format: int64 - ObjectSizeLessThanBytes: - type: integer - format: int64 - ObjectStorageClass: - type: string - enum: - - STANDARD - - REDUCED_REDUNDANCY - - GLACIER - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - - SNOW - - EXPRESS_ONEZONE - - FSX_OPENZFS - - FSX_ONTAP - ObjectVersion: - type: object - properties: - ETag: - $ref: '#/components/schemas/ETag' - description: The entity tag is an MD5 hash of that version of the object. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithmList' - description: The algorithm that was used to create a checksum of the object. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: The checksum type that is used to calculate the object’s checksum - value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - Size: - $ref: '#/components/schemas/Size' - description: Size in bytes of the object. - StorageClass: - $ref: '#/components/schemas/ObjectVersionStorageClass' - description: The class of storage used to store the object. - Key: - $ref: '#/components/schemas/ObjectKey' - description: The object key. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: Version ID of an object. - IsLatest: - $ref: '#/components/schemas/IsLatest' - description: Specifies whether the object is (true) or is not (false) the - latest version of an object. - LastModified: - $ref: '#/components/schemas/LastModified' - description: Date and time when the object was last modified. - Owner: - $ref: '#/components/schemas/Owner' - description: Specifies the owner of the object. - RestoreStatus: - $ref: '#/components/schemas/RestoreStatus' - description: 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) - in the _Amazon S3 User Guide_. - description: The version of an object. - ObjectVersionId: - type: string - ObjectVersionList: - type: array - items: - $ref: '#/components/schemas/ObjectVersion' - ObjectVersionStorageClass: - type: string - enum: - - STANDARD - OptionalObjectAttributes: - type: string - enum: - - RestoreStatus - OptionalObjectAttributesList: - type: array - items: - $ref: '#/components/schemas/OptionalObjectAttributes' - OutputLocation: - type: object - properties: - S3: - $ref: '#/components/schemas/S3Location' - description: Describes an S3 location that will receive the results of the - restore request. - description: Describes the location where the restore job's output is stored. - OutputSerialization: - type: object - properties: - CSV: - $ref: '#/components/schemas/CSVOutput' - description: Describes the serialization of CSV-encoded Select results. - JSON: - $ref: '#/components/schemas/JSONOutput' - description: Specifies JSON as request's output serialization format. - description: Describes how results of the Select job are serialized. - Owner: - type: object - properties: - DisplayName: - $ref: '#/components/schemas/DisplayName' - description: '' - ID: - $ref: '#/components/schemas/ID' - description: Container for the ID of the owner. - description: Container for the owner's display name and ID. - OwnerOverride: - type: string - enum: - - Destination - OwnershipControls: - type: object - properties: - Rules: - $ref: '#/components/schemas/OwnershipControlsRules' - description: The container element for an ownership control rule. - required: - - Rules - description: The container element for a bucket's ownership controls. - OwnershipControlsRule: - type: object - properties: - ObjectOwnership: - $ref: '#/components/schemas/ObjectOwnership' - required: - - ObjectOwnership - description: The container element for an ownership control rule. - OwnershipControlsRules: - type: array - items: - $ref: '#/components/schemas/OwnershipControlsRule' - ParquetInput: - type: object - properties: {} - description: Container for Parquet. - Part: - type: object - properties: - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: Part number identifying the part. This is a positive integer - between 1 and 10,000. - LastModified: - $ref: '#/components/schemas/LastModified' - description: Date and time at which the part was uploaded. - ETag: - $ref: '#/components/schemas/ETag' - description: Entity tag returned when the part was uploaded. - Size: - $ref: '#/components/schemas/Size' - description: Size in bytes of the uploaded part data. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32` checksum of the part. This - checksum is present if the object was uploaded with the `CRC32` checksum - algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the part. This - checksum is present if the object was uploaded with the `CRC32C` checksum - algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. - This checksum is present if the multipart upload request was created with - the `CRC64NVME` checksum algorithm, or if the object was uploaded without - a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to - the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` checksum of the part. This - checksum is present if the object was uploaded with the `SHA1` checksum - algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` checksum of the part. - This checksum is present if the object was uploaded with the `SHA256` - checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - description: Container for elements related to a part. - PartNumber: - type: integer - PartNumberMarker: - type: string - PartitionDateSource: - type: string - enum: - - EventTime - - DeliveryTime - PartitionedPrefix: - type: object - properties: - PartitionDateSource: - $ref: '#/components/schemas/PartitionDateSource' - description: 'Specifies the partition date source for the partitioned prefix. - `PartitionDateSource` can be `EventTime` or `DeliveryTime`. - - - For `DeliveryTime`, the time in the log file names corresponds to the - delivery time for the log files. - - - For `EventTime`, The logs delivered are for a specific day only. The year, - month, and day correspond to the day on which the event occurred, and - the hour, minutes and seconds are set to 00 in the key.' - description: 'Amazon S3 keys for log objects are partitioned in the following - format: - - - `[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]` - - - PartitionedPrefix defaults to EventTime delivery when server access logs are - delivered.' - Parts: - type: array - items: - $ref: '#/components/schemas/Part' - PartsCount: - type: integer - PartsList: - type: array - items: - $ref: '#/components/schemas/ObjectPart' - Payer: - type: string - enum: - - Requester - - BucketOwner - Permission: - type: string - enum: - - FULL_CONTROL - - WRITE - - WRITE_ACP - - READ - - READ_ACP - Policy: - type: string - PolicyStatus: - type: object - properties: - IsPublic: - $ref: '#/components/schemas/IsPublic' - description: The policy status for this bucket. `TRUE` indicates that this - bucket is public. `FALSE` indicates that the bucket is not public. - description: The container element for a bucket's policy status. - Prefix: - type: string - Priority: - type: integer - Progress: - type: object - properties: - BytesScanned: - $ref: '#/components/schemas/BytesScanned' - description: The current number of object bytes scanned. - BytesProcessed: - $ref: '#/components/schemas/BytesProcessed' - description: The current number of uncompressed object bytes processed. - BytesReturned: - $ref: '#/components/schemas/BytesReturned' - description: The current number of bytes of records payload data returned. - description: This data type contains information about progress of an operation. - ProgressEvent: - type: object - properties: - Details: - $ref: '#/components/schemas/Progress' - description: The Progress event details. - description: This data type contains information about the progress event of - an operation. - Protocol: - type: string - enum: - - http - - https - PublicAccessBlockConfiguration: - type: object - properties: - BlockPublicAcls: - $ref: '#/components/schemas/Setting' - description: "Specifies whether Amazon S3 should block public access control\ - \ lists (ACLs) for this bucket and objects in this bucket. Setting this\ - \ element to `TRUE` causes the following behavior:\n\n * PUT Bucket ACL\ - \ and PUT Object ACL calls fail if the specified ACL is public.\n\n *\ - \ PUT Object calls fail if the request includes a public ACL.\n\n * PUT\ - \ Bucket calls fail if the request includes a public ACL.\n\nEnabling\ - \ this setting doesn't affect existing policies or ACLs." - IgnorePublicAcls: - $ref: '#/components/schemas/Setting' - description: 'Specifies whether Amazon S3 should ignore public ACLs for - this bucket and objects in this bucket. Setting this element to `TRUE` - causes Amazon S3 to ignore all public ACLs on this bucket and objects - in this bucket. - - - Enabling this setting doesn''t affect the persistence of any existing - ACLs and doesn''t prevent new public ACLs from being set.' - BlockPublicPolicy: - $ref: '#/components/schemas/Setting' - description: 'Specifies whether Amazon S3 should block public bucket policies - for this bucket. Setting this element to `TRUE` causes Amazon S3 to reject - calls to PUT Bucket policy if the specified bucket policy allows public - access. - - - Enabling this setting doesn''t affect existing bucket policies.' - RestrictPublicBuckets: - $ref: '#/components/schemas/Setting' - description: 'Specifies whether Amazon S3 should restrict public bucket - policies for this bucket. Setting this element to `TRUE` restricts access - to this bucket to only Amazon Web Services service principals and authorized - users within this account if the bucket has a public policy. - - - Enabling this setting doesn''t affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, - including non-public delegation to specific accounts, is blocked.' - description: The PublicAccessBlock configuration that you want to apply to this - Amazon S3 bucket. You can enable the configuration options in any combination. - Bucket-level settings work alongside account-level settings (which may inherit - from organization-level policies). For more information about when Amazon - S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) - in the _Amazon S3 User Guide_. - PutBucketAbacRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the general purpose bucket. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash of the `PutBucketAbac` request body. - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: Indicates the algorithm that you want Amazon S3 to use to create - the checksum. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services account ID of the general purpose bucket's - owner. - AbacStatus: - $ref: '#/components/schemas/AbacStatus' - description: The ABAC status of the general purpose bucket. When ABAC is - enabled for the general purpose bucket, you can use tags to manage access - to the general purpose buckets as well as for cost tracking purposes. - When ABAC is disabled for the general purpose buckets, you can only use - tags for cost tracking purposes. For more information, see [Using tags - with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html). - required: - - Bucket - - AbacStatus - PutBucketAccelerateConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which the accelerate configuration - is set. - AccelerateConfiguration: - $ref: '#/components/schemas/AccelerateConfiguration' - description: Container for setting the transfer acceleration state. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - required: - - Bucket - - AccelerateConfiguration - PutBucketAclRequest: - type: object - properties: - ACL: - $ref: '#/components/schemas/BucketCannedACL' - description: The canned ACL to apply to the bucket. - AccessControlPolicy: - $ref: '#/components/schemas/AccessControlPolicy' - description: Contains the elements that set the ACL permissions for an object - per grantee. - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket to which to apply the ACL. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. This - header must be used as a message integrity check to verify that the request - body was not corrupted in transit. For more information, go to [RFC 1864.](http://www.ietf.org/rfc/rfc1864.txt) - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - GrantFullControl: - $ref: '#/components/schemas/GrantFullControl' - description: Allows grantee the read, write, read ACP, and write ACP permissions - on the bucket. - GrantRead: - $ref: '#/components/schemas/GrantRead' - description: Allows grantee to list the objects in the bucket. - GrantReadACP: - $ref: '#/components/schemas/GrantReadACP' - description: Allows grantee to read the bucket ACL. - GrantWrite: - $ref: '#/components/schemas/GrantWrite' - description: '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.' - GrantWriteACP: - $ref: '#/components/schemas/GrantWriteACP' - description: Allows grantee to write the ACL for the applicable bucket. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - PutBucketAnalyticsConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket to which an analytics configuration - is stored. - Id: - $ref: '#/components/schemas/AnalyticsId' - description: The ID that identifies the analytics configuration. - AnalyticsConfiguration: - $ref: '#/components/schemas/AnalyticsConfiguration' - description: The configuration and any analyses for the analytics filter. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - - AnalyticsConfiguration - PutBucketCorsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: Specifies the bucket impacted by the `cors`configuration. - CORSConfiguration: - $ref: '#/components/schemas/CORSConfiguration' - description: Describes the cross-origin access configuration for objects - in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin - Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) - in the _Amazon S3 User Guide_. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. This - header must be used as a message integrity check to verify that the request - body was not corrupted in transit. For more information, go to [RFC 1864.](http://www.ietf.org/rfc/rfc1864.txt) - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - CORSConfiguration - PutBucketEncryptionRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'Specifies default encryption for a bucket using server-side - encryption with different key options. - - - **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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the server-side - encryption configuration. - - - 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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter. - - - For directory buckets, when you use Amazon Web Services SDKs, `CRC32` - is the default checksum algorithm that''s used for performance.' - ServerSideEncryptionConfiguration: - $ref: '#/components/schemas/ServerSideEncryptionConfiguration' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - - ServerSideEncryptionConfiguration - PutBucketIntelligentTieringConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose configuration you want - to modify or retrieve. - Id: - $ref: '#/components/schemas/IntelligentTieringId' - description: The ID used to identify the S3 Intelligent-Tiering configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - IntelligentTieringConfiguration: - $ref: '#/components/schemas/IntelligentTieringConfiguration' - description: Container for S3 Intelligent-Tiering configuration. - required: - - Bucket - - Id - - IntelligentTieringConfiguration - PutBucketInventoryConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket where the inventory configuration will - be stored. - Id: - $ref: '#/components/schemas/InventoryId' - description: The ID used to identify the inventory configuration. - InventoryConfiguration: - $ref: '#/components/schemas/InventoryConfiguration' - description: Specifies the inventory configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - - InventoryConfiguration - PutBucketLifecycleConfigurationOutput: - type: object - properties: - TransitionDefaultMinimumObjectSize: - $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' - description: "Indicates which default minimum object size behavior is applied\ - \ to the lifecycle configuration.\n\nThis parameter applies to general\ - \ purpose buckets only. It is not supported for directory bucket lifecycle\ - \ configurations.\n\n * `all_storage_classes_128K` \\- Objects smaller\ - \ than 128 KB will not transition to any storage class by default. \n\n\ - \ * `varies_by_storage_class` \\- Objects smaller than 128 KB will transition\ - \ to Glacier Flexible Retrieval or Glacier Deep Archive storage classes.\ - \ By default, all other storage classes will prevent transitions smaller\ - \ than 128 KB. \n\nTo customize the minimum object size for any transition\ - \ you can add a filter that specifies a custom `ObjectSizeGreaterThan`\ - \ or `ObjectSizeLessThan` in the body of your transition rule. Custom\ - \ filters always take precedence over the default transition behavior." - PutBucketLifecycleConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which to set the configuration. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - LifecycleConfiguration: - $ref: '#/components/schemas/BucketLifecycleConfiguration' - description: Container for lifecycle rules. You can add as many as 1,000 - rules. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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). - - - This parameter applies to general purpose buckets only. It is not supported - for directory bucket lifecycle configurations.' - TransitionDefaultMinimumObjectSize: - $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' - description: "Indicates which default minimum object size behavior is applied\ - \ to the lifecycle configuration.\n\nThis parameter applies to general\ - \ purpose buckets only. It is not supported for directory bucket lifecycle\ - \ configurations.\n\n * `all_storage_classes_128K` \\- Objects smaller\ - \ than 128 KB will not transition to any storage class by default. \n\n\ - \ * `varies_by_storage_class` \\- Objects smaller than 128 KB will transition\ - \ to Glacier Flexible Retrieval or Glacier Deep Archive storage classes.\ - \ By default, all other storage classes will prevent transitions smaller\ - \ than 128 KB. \n\nTo customize the minimum object size for any transition\ - \ you can add a filter that specifies a custom `ObjectSizeGreaterThan`\ - \ or `ObjectSizeLessThan` in the body of your transition rule. Custom\ - \ filters always take precedence over the default transition behavior." - required: - - Bucket - PutBucketLoggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which to set the logging parameters. - BucketLoggingStatus: - $ref: '#/components/schemas/BucketLoggingStatus' - description: Container for logging status information. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash of the `PutBucketLogging` request body. - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - BucketLoggingStatus - PutBucketMetricsConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket for which the metrics configuration - is set. - Id: - $ref: '#/components/schemas/MetricsId' - description: The ID used to identify the metrics configuration. The ID has - a 64 character limit and can only contain letters, numbers, periods, dashes, - and underscores. - MetricsConfiguration: - $ref: '#/components/schemas/MetricsConfiguration' - description: Specifies the metrics configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Id - - MetricsConfiguration - PutBucketNotificationConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket. - NotificationConfiguration: - $ref: '#/components/schemas/NotificationConfiguration' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - SkipDestinationValidation: - $ref: '#/components/schemas/SkipValidation' - description: Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. - True or false value. - required: - - Bucket - - NotificationConfiguration - PutBucketOwnershipControlsRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose `OwnershipControls` - you want to set. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash of the `OwnershipControls` request body. - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - OwnershipControls: - $ref: '#/components/schemas/OwnershipControls' - description: The `OwnershipControls` (BucketOwnerEnforced, BucketOwnerPreferred, - or ObjectWriter) that you want to apply to this Amazon S3 bucket. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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_ ` header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code `400 Bad Request`. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - required: - - Bucket - - OwnershipControls - PutBucketPolicyRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 Zone (Availability Zone or Local Zone). Bucket - names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` - (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information - about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_' - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: '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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: "Indicates the algorithm used to create the checksum for the\ - \ request 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`.\n\nFor the `x-amz-checksum-_algorithm_ ` header,\ - \ replace ` _algorithm_ ` with the supported algorithm from the following\ - \ list:\n\n * `CRC32`\n\n * `CRC32C`\n\n * `CRC64NVME`\n\n * `SHA1`\n\ - \n * `SHA256`\n\nFor more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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\ - \ fails the request with a `BadDigest` error.\n\nFor directory buckets,\ - \ when you use Amazon Web Services SDKs, `CRC32` is the default checksum\ - \ algorithm that's used for performance." - ConfirmRemoveSelfBucketAccess: - $ref: '#/components/schemas/ConfirmRemoveSelfBucketAccess' - description: '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.' - Policy: - $ref: '#/components/schemas/Policy' - description: 'The bucket policy as a JSON document. - - - For directory buckets, the only IAM action supported in the bucket policy - is `s3express:CreateSession`.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: '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`.' - required: - - Bucket - - Policy - PutBucketReplicationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ReplicationConfiguration: - $ref: '#/components/schemas/ReplicationConfiguration' - Token: - $ref: '#/components/schemas/ObjectLockToken' - description: A token to allow Object Lock to be enabled for an existing - bucket. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - ReplicationConfiguration - PutBucketRequestPaymentRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - RequestPaymentConfiguration: - $ref: '#/components/schemas/RequestPaymentConfiguration' - description: Container for Payer. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - RequestPaymentConfiguration - PutBucketTaggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - Tagging: - $ref: '#/components/schemas/Tagging' - description: Container for the `TagSet` and `Tag` elements. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Tagging - PutBucketVersioningRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: '>The Base64 encoded 128-bit `MD5` digest of the data. You - must use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - MFA: - $ref: '#/components/schemas/MFA' - description: The concatenation of the authentication device's serial number, - a space, and the value that is displayed on your authentication device. - The serial number is the number that uniquely identifies the MFA device. - For physical MFA devices, this is the unique serial number that's provided - with the device. For virtual MFA devices, the serial number is the device - ARN. For more information, see [Enabling versioning on buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html) - and [Configuring MFA delete](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiFactorAuthenticationDelete.html) - in the _Amazon Simple Storage Service User Guide_. - VersioningConfiguration: - $ref: '#/components/schemas/VersioningConfiguration' - description: Container for setting the versioning state. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - VersioningConfiguration - PutBucketWebsiteRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket name. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: 'Indicates the algorithm used to create the checksum for the - request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - WebsiteConfiguration: - $ref: '#/components/schemas/WebsiteConfiguration' - description: Container for the request. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - WebsiteConfiguration - PutObjectAclOutput: - type: object - properties: - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - PutObjectAclRequest: - type: object - properties: - ACL: - $ref: '#/components/schemas/ObjectCannedACL' - description: The canned ACL to apply to the object. For more information, - see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). - AccessControlPolicy: - $ref: '#/components/schemas/AccessControlPolicy' - description: Contains the elements that set the ACL permissions for an object - per grantee. - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The Base64 encoded 128-bit `MD5` digest of the data. This - header must be used as a message integrity check to verify that the request - body was not corrupted in transit. For more information, go to [RFC 1864.>](http://www.ietf.org/rfc/rfc1864.txt) - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - GrantFullControl: - $ref: '#/components/schemas/GrantFullControl' - description: 'Allows grantee the read, write, read ACP, and write ACP permissions - on the bucket. - - - This functionality is not supported for Amazon S3 on Outposts.' - GrantRead: - $ref: '#/components/schemas/GrantRead' - description: 'Allows grantee to list the objects in the bucket. - - - This functionality is not supported for Amazon S3 on Outposts.' - GrantReadACP: - $ref: '#/components/schemas/GrantReadACP' - description: 'Allows grantee to read the bucket ACL. - - - This functionality is not supported for Amazon S3 on Outposts.' - GrantWrite: - $ref: '#/components/schemas/GrantWrite' - description: '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.' - GrantWriteACP: - $ref: '#/components/schemas/GrantWriteACP' - description: 'Allows grantee to write the ACL for the applicable bucket. - - - This functionality is not supported for Amazon S3 on Outposts.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Key for which the PUT action was initiated. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: 'Version ID used to reference a specific version of the object. - - - This functionality is not supported for directory buckets.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - PutObjectLegalHoldOutput: - type: object - properties: - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - PutObjectLegalHoldRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key name for the object that you want to place a legal - hold on. - LegalHold: - $ref: '#/components/schemas/ObjectLockLegalHold' - description: Container element for the legal hold configuration you want - to apply to the specified object. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The version ID of the object that you want to place a legal - hold on. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash for 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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - PutObjectLockConfigurationOutput: - type: object - properties: - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - PutObjectLockConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The bucket whose Object Lock configuration you want to create - or replace. - ObjectLockConfiguration: - $ref: '#/components/schemas/ObjectLockConfiguration' - description: The Object Lock configuration that you want to apply to the - specified bucket. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - Token: - $ref: '#/components/schemas/ObjectLockToken' - description: A token to allow Object Lock to be enabled for an existing - bucket. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash for 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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - PutObjectOutput: - type: object - properties: - Expiration: - $ref: '#/components/schemas/Expiration' - description: 'If the expiration is configured for the object (see [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)) - 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. - - - Object expiration information is not returned in directory buckets and - this header returns the value "`NotImplemented`" in all responses for - directory buckets.' - ETag: - $ref: '#/components/schemas/ETag' - description: '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.' - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. - This header is present if the object was uploaded with the `CRC64NVME` - checksum algorithm, or if it was uploaded without a checksum (and Amazon - S3 added the default checksum, `CRC64NVME`, to the uploaded object). For - more information about how checksums are calculated with multipart uploads, - see [Checking object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumType: - $ref: '#/components/schemas/ChecksumType' - description: This header specifies the checksum type of the object, which - determines how part-level checksums are combined to create an object-level - checksum for multipart objects. For `PutObject` uploads, the checksum - type is always `FULL_OBJECT`. You can use this header as a data integrity - check to verify that the checksum type that is received is the same checksum - that was specified. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html) - in the _Amazon S3 User Guide_. For information about returning the versioning - state of a bucket, see [GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html). - - - This functionality is not supported for directory buckets.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: If present, indicates the Amazon Web Services KMS Encryption - Context to use for object encryption. The value of this header is a Base64 - encoded string of a UTF-8 encoded JSON, which contains the encryption - context as key-value pairs. This value is stored as object metadata and - automatically gets passed on to Amazon Web Services KMS for future `GetObject` - operations on this object. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the uploaded object uses an S3 Bucket Key - for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). - Size: - $ref: '#/components/schemas/Size' - description: 'The size of the object in bytes. This value is only be present - if you append to an object. - - - This functionality is only supported for objects in the Amazon S3 Express - One Zone storage class in directory buckets.' - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - PutObjectRequest: - type: object - properties: - ACL: - $ref: '#/components/schemas/ObjectCannedACL' - description: "The canned ACL to apply to the object. For more information,\ - \ see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL)\ - \ in the _Amazon S3 User Guide_.\n\nWhen 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ - \ and [Managing ACLs Using the REST API](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ - \ in the _Amazon S3 User Guide_.\n\n * This functionality is not supported\ - \ for directory buckets.\n\n * This functionality is not supported for\ - \ Amazon S3 on Outposts." - Body: - $ref: '#/components/schemas/StreamingBlob' - description: Object data. - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - CacheControl: - $ref: '#/components/schemas/CacheControl' - description: Can be used to specify caching behavior along the request/reply - chain. For more information, see . - ContentDisposition: - $ref: '#/components/schemas/ContentDisposition' - description: Specifies presentational information for the object. For more - information, see . - ContentEncoding: - $ref: '#/components/schemas/ContentEncoding' - description: 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 more information, see - . - ContentLanguage: - $ref: '#/components/schemas/ContentLanguage' - description: The language the content is in. - ContentLength: - $ref: '#/components/schemas/ContentLength' - description: Size of the body in bytes. This parameter is useful when the - size of the body cannot be determined automatically. For more information, - see . - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). - - - The `Content-MD5` or `x-amz-sdk-checksum-algorithm` header is required - for any request to upload an object with a retention period configured - using Amazon S3 Object Lock. For more information, see [Uploading objects - to an Object Lock enabled bucket ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - ContentType: - $ref: '#/components/schemas/ContentType' - description: A standard MIME type describing the format of the contents. - For more information, see . - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: "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`.\n\nFor the `x-amz-checksum-_algorithm_ ` header,\ - \ replace ` _algorithm_ ` with the supported algorithm from the following\ - \ list:\n\n * `CRC32`\n\n * `CRC32C`\n\n * `CRC64NVME`\n\n * `SHA1`\n\ - \n * `SHA256`\n\nFor more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)\ - \ in the _Amazon S3 User Guide_.\n\nIf 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\ - \ fails the request with a `BadDigest` error.\n\nThe `Content-MD5` or\ - \ `x-amz-sdk-checksum-algorithm` header is required for any request to\ - \ upload an object with a retention period configured using Amazon S3\ - \ Object Lock. For more information, see [Uploading objects to an Object\ - \ Lock enabled bucket ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object)\ - \ in the _Amazon S3 User Guide_.\n\nFor directory buckets, when you use\ - \ Amazon Web Services SDKs, `CRC32` is the default checksum algorithm\ - \ that's used for performance." - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32` checksum of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the - object. The `CRC64NVME` checksum is always a full object checksum. For - more information, see [Checking object integrity in the Amazon S3 User - Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 160-bit `SHA1` digest of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 256-bit `SHA256` digest of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - Expires: - $ref: '#/components/schemas/Expires' - description: The date and time at which the object is no longer cacheable. - For more information, see . - IfMatch: - $ref: '#/components/schemas/IfMatch' - description: 'Uploads the object only if the ETag (entity tag) value provided - during the WRITE operation matches the ETag of the object in S3. If the - ETag values do not match, the operation returns a `412 Precondition Failed` - error. - - - If a conflicting operation occurs during the upload S3 returns a `409 - ConditionalRequestConflict` response. On a 409 failure you should fetch - the object''s ETag and retry the upload. - - - Expects the ETag value as a string. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), - or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) - in the _Amazon S3 User Guide_.' - IfNoneMatch: - $ref: '#/components/schemas/IfNoneMatch' - description: 'Uploads the object only if the object key name does not already - exist in the bucket specified. Otherwise, Amazon S3 returns a `412 Precondition - Failed` error. - - - If a conflicting operation occurs during the upload S3 returns a `409 - ConditionalRequestConflict` response. On a 409 failure you should retry - the upload. - - - Expects the ''*'' (asterisk) character. - - - For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), - or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) - in the _Amazon S3 User Guide_.' - GrantFullControl: - $ref: '#/components/schemas/GrantFullControl' - description: "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions\ - \ on the object.\n\n * This functionality is not supported for directory\ - \ buckets.\n\n * This functionality is not supported for Amazon S3 on\ - \ Outposts." - GrantRead: - $ref: '#/components/schemas/GrantRead' - description: "Allows grantee to read the object data and its metadata.\n\ - \n * This functionality is not supported for directory buckets.\n\n \ - \ * This functionality is not supported for Amazon S3 on Outposts." - GrantReadACP: - $ref: '#/components/schemas/GrantReadACP' - description: "Allows grantee to read the object ACL.\n\n * This functionality\ - \ is not supported for directory buckets.\n\n * This functionality is\ - \ not supported for Amazon S3 on Outposts." - GrantWriteACP: - $ref: '#/components/schemas/GrantWriteACP' - description: "Allows grantee to write the ACL for the applicable object.\n\ - \n * This functionality is not supported for directory buckets.\n\n \ - \ * This functionality is not supported for Amazon S3 on Outposts." - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the PUT action was initiated. - WriteOffsetBytes: - $ref: '#/components/schemas/WriteOffsetBytes' - description: 'Specifies the offset for appending data to existing objects - in bytes. The offset must be equal to the size of the existing object - being appended to. If no object exists, setting this header to 0 will - create a new object. - - - This functionality is only supported for objects in the Amazon S3 Express - One Zone storage class in directory buckets.' - Metadata: - $ref: '#/components/schemas/Metadata' - description: A map of metadata to store with the object in S3. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: "The server-side encryption algorithm that was used when you\ - \ store this object in Amazon S3 or Amazon FSx.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- For\ - \ directory buckets, there are only two supported options for server-side\ - \ encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)\ - \ (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).\ - \ We recommend that the bucket's default encryption uses the desired encryption\ - \ configuration and you don't override the bucket default encryption in\ - \ your `CreateSession` requests or `PUT` object requests. Then, new objects\ - \ are automatically encrypted with the desired encryption settings. For\ - \ more information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ - \ in the _Amazon S3 User Guide_. For more information about the encryption\ - \ overriding behaviors in directory buckets, see [Specifying server-side\ - \ encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\ - \ \n\nIn the Zonal endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))\ - \ using the REST API, the encryption request headers must match the encryption\ - \ settings that are specified in the `CreateSession` request. You can't\ - \ override the values of the encryption settings (`x-amz-server-side-encryption`,\ - \ `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`,\ - \ and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified\ - \ in the `CreateSession` request. You don't need to explicitly specify\ - \ these encryption settings values in Zonal endpoint API calls, and Amazon\ - \ S3 will use the encryption settings values from the `CreateSession`\ - \ request to protect new objects in the directory bucket.\n\nWhen you\ - \ use the CLI or the Amazon Web Services SDKs, for `CreateSession`, the\ - \ session token refreshes automatically to avoid service interruptions\ - \ when a session expires. The CLI or the Amazon Web Services SDKs use\ - \ the bucket's default encryption configuration for the `CreateSession`\ - \ request. It's not supported to override the encryption settings values\ - \ in the `CreateSession` request. So in the Zonal endpoint API calls (except\ - \ [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ - \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),\ - \ the encryption request headers must match the default encryption configuration\ - \ of the directory bucket.\n\n * **S3 access points for Amazon FSx**\ - \ \\- When accessing data stored in Amazon FSx file systems using S3 access\ - \ points, the only valid server side encryption option is `aws:fsx`. All\ - \ Amazon FSx file systems have encryption configured by default and are\ - \ encrypted at rest. Data is automatically encrypted before being written\ - \ to the file system, and automatically decrypted as it is read. These\ - \ processes are handled transparently by Amazon FSx." - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)\ - \ in the _Amazon S3 User Guide_.\n\n * Directory buckets only support\ - \ `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability\ - \ Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class)\ - \ in Dedicated Local Zones.\n\n * Amazon S3 on Outposts only uses the\ - \ OUTPOSTS Storage Class." - WebsiteRedirectLocation: - $ref: '#/components/schemas/WebsiteRedirectLocation' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) - 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) - and [How to Configure Website Page Redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: 'Specifies the algorithm to use when encrypting the object - (for example, `AES256`). - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: 'Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to - use for object encryption. If the KMS key doesn''t exist in the same account - that''s issuing the command, you must use the full Key ARN not the Key - ID. - - - **General purpose buckets** \- If you specify `x-amz-server-side-encryption` - with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, - Key ARN, or Key Alias) of the KMS key to use. 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. - - - **Directory buckets** \- To encrypt data using SSE-KMS, it''s recommended - to specify the `x-amz-server-side-encryption` header to `aws:kms`. Then, - the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses - the bucket''s default KMS customer managed key ID. If you want to explicitly - set the ` x-amz-server-side-encryption-aws-kms-key-id` header, it must - match the bucket''s default customer managed key (using key ID or ARN, - not alias). Your SSE-KMS configuration can only support 1 [customer managed - key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) - per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) - (`aws/s3`) isn''t supported. Incorrect key specification results in an - HTTP `400 Bad Request` error.' - SSEKMSEncryptionContext: - $ref: '#/components/schemas/SSEKMSEncryptionContext' - description: 'Specifies the Amazon Web Services KMS Encryption Context as - an additional encryption context to use for object encryption. The value - of this header is a Base64 encoded string of a UTF-8 encoded JSON, which - contains the encryption context as key-value pairs. This value is stored - as object metadata and automatically gets passed on to Amazon Web Services - KMS for future `GetObject` operations on this object. - - - **General purpose buckets** \- This value must be explicitly added during - `CopyObject` operations if you want an additional encryption context for - your object. For more information, see [Encryption context](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context) - in the _Amazon S3 User Guide_. - - - **Directory buckets** \- You can optionally provide an explicit encryption - context value. The value must match the default encryption context - the - bucket Amazon Resource Name (ARN). An additional encryption context value - is not supported.' - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: '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). - - - **General purpose buckets** \- Setting this header to `true` causes Amazon - S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying - this header with a PUT action doesn''t affect bucket-level settings for - S3 Bucket Key. - - - **Directory buckets** \- S3 Bucket Keys are always enabled for `GET` and - `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket - Keys aren''t supported, when you copy SSE-KMS encrypted objects from general - purpose buckets to directory buckets, from directory buckets to general - purpose buckets, or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), - [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), - [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), - or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). - In this case, Amazon S3 makes a call to KMS every time a copy request - is made for a KMS-encrypted object.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - Tagging: - $ref: '#/components/schemas/TaggingHeader' - description: '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.' - ObjectLockMode: - $ref: '#/components/schemas/ObjectLockMode' - description: 'The Object Lock mode that you want to apply to this object. - - - This functionality is not supported for directory buckets.' - ObjectLockRetainUntilDate: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - description: '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.' - ObjectLockLegalHoldStatus: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: 'Specifies whether a legal hold will be applied to this object. - For more information about S3 Object Lock, see [Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - PutObjectRetentionOutput: - type: object - properties: - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - PutObjectRetentionRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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 for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: The key name for the object that you want to apply this Object - Retention configuration to. - Retention: - $ref: '#/components/schemas/ObjectLockRetention' - description: The container element for the Object Retention configuration. - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The version ID for the object that you want to apply this Object - Retention configuration to. - BypassGovernanceRetention: - $ref: '#/components/schemas/BypassGovernanceRetention' - description: Indicates whether this action should bypass Governance-mode - restrictions. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash for 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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - PutObjectTaggingOutput: - type: object - properties: - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The versionId of the object the tag-set was added to. - PutObjectTaggingRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket name containing the object. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Name of the object key. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: The versionId of the object that the tag-set will be added - to. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash for 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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - Tagging: - $ref: '#/components/schemas/Tagging' - description: Container for the `TagSet` and `Tag` elements - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - description: Confirms that the requester knows that she or he will be charged - for the tagging object request. Bucket owners need not specify this parameter - in their requests. - required: - - Bucket - - Key - - Tagging - PutPublicAccessBlockRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The name of the Amazon S3 bucket whose `PublicAccessBlock` - configuration you want to set. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: 'The MD5 hash of the `PutPublicAccessBlock` request body. - - - For requests made using the Amazon Web Services Command Line Interface - (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - PublicAccessBlockConfiguration: - $ref: '#/components/schemas/PublicAccessBlockConfiguration' - description: The `PublicAccessBlock` configuration that you want to apply - to this Amazon S3 bucket. You can enable the configuration options in - any combination. For more information about when Amazon S3 considers a - bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) - in the _Amazon S3 User Guide_. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - PublicAccessBlockConfiguration - QueueArn: - type: string - QueueConfiguration: - type: object - properties: - Id: - $ref: '#/components/schemas/NotificationId' - QueueArn: - $ref: '#/components/schemas/QueueArn' - description: The Amazon Resource Name (ARN) of the Amazon SQS queue to which - Amazon S3 publishes a message when it detects events of the specified - type. - Events: - $ref: '#/components/schemas/EventList' - description: A collection of bucket events for which to send notifications - Filter: - $ref: '#/components/schemas/NotificationConfigurationFilter' - required: - - QueueArn - - Events - description: Specifies the configuration for publishing messages to an Amazon - Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. - QueueConfigurationList: - type: array - items: - $ref: '#/components/schemas/QueueConfiguration' - Quiet: - type: boolean - QuoteCharacter: - type: string - QuoteEscapeCharacter: - type: string - QuoteFields: - type: string - enum: - - ALWAYS - - ASNEEDED - Range: - type: string - RecordDelimiter: - type: string - RecordExpiration: - type: object - properties: - Expiration: - $ref: '#/components/schemas/ExpirationState' - description: Specifies whether journal table record expiration is enabled - or disabled. - Days: - $ref: '#/components/schemas/RecordExpirationDays' - description: If you enable journal table record expiration, you can set - the number of days to retain your journal table records. Journal table - records must be retained for a minimum of 7 days. To set this value, specify - any whole number from `7` to `2147483647`. For example, to retain your - journal table records for one year, set this value to `365`. - required: - - Expiration - description: The journal table record expiration settings for a journal table - in an S3 Metadata configuration. - RecordExpirationDays: - type: integer - RecordsEvent: - type: object - properties: - Payload: - $ref: '#/components/schemas/Body' - description: The byte array of partial, one or more result records. S3 Select - doesn't guarantee that a record will be self-contained in one record frame. - To ensure continuous streaming of data, S3 Select might split the same - record across multiple record frames instead of aggregating the results - in memory. Some S3 clients (for example, the SDK for Java) handle this - behavior by creating a `ByteStream` out of the response by default. Other - clients might not handle this behavior by default. In those cases, you - must aggregate the results on the client side and parse the response. - description: The container for the records event. - Redirect: - type: object - properties: - HostName: - $ref: '#/components/schemas/HostName' - description: The host name to use in the redirect request. - HttpRedirectCode: - $ref: '#/components/schemas/HttpRedirectCode' - description: The HTTP redirect code to use on the response. Not required - if one of the siblings is present. - Protocol: - $ref: '#/components/schemas/Protocol' - description: Protocol to use when redirecting requests. The default is the - protocol that is used in the original request. - ReplaceKeyPrefixWith: - $ref: '#/components/schemas/ReplaceKeyPrefixWith' - description: 'The object key prefix to use in the redirect request. For - example, to redirect requests for all pages with prefix `docs/` (objects - in the `docs/` folder) to `documents/`, you can set a condition block - with `KeyPrefixEquals` set to `docs/` and in the Redirect set `ReplaceKeyPrefixWith` - to `/documents`. Not required if one of the siblings is present. Can be - present only if `ReplaceKeyWith` is not provided. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - ReplaceKeyWith: - $ref: '#/components/schemas/ReplaceKeyWith' - description: 'The specific object key to use in the redirect request. For - example, redirect request to `error.html`. Not required if one of the - siblings is present. Can be present only if `ReplaceKeyPrefixWith` is - not provided. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - description: Specifies how requests are redirected. In the event of an error, - you can specify a different error code to return. - RedirectAllRequestsTo: - type: object - properties: - HostName: - $ref: '#/components/schemas/HostName' - description: Name of the host where requests are redirected. - Protocol: - $ref: '#/components/schemas/Protocol' - description: Protocol to use when redirecting requests. The default is the - protocol that is used in the original request. - required: - - HostName - description: Specifies the redirect behavior of all requests to a website endpoint - of an Amazon S3 bucket. - Region: - type: string - minLength: 0 - maxLength: 20 - RenameObjectOutput: - type: object - properties: {} - RenameObjectRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket name of the directory bucket containing the object. - - - You must use virtual-hosted-style requests in the format `Bucket-name.s3express-zone-id.region-code.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--zone-id--x-s3 ` (for example, `amzn-s3-demo-bucket--usw2-az1--x-s3`). - For information about bucket naming restrictions, see [Directory bucket - naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Key name of the object to rename. - RenameSource: - $ref: '#/components/schemas/RenameSource' - description: Specifies the source for the rename operation. The value must - be URL encoded. - DestinationIfMatch: - $ref: '#/components/schemas/IfMatch' - description: 'Renames the object only if the ETag (entity tag) value provided - during the operation matches the ETag of the object in S3. The `If-Match` - header field makes the request method conditional on ETags. If the ETag - values do not match, the operation returns a `412 Precondition Failed` - error. - - - Expects the ETag value as a string.' - DestinationIfNoneMatch: - $ref: '#/components/schemas/IfNoneMatch' - description: 'Renames the object only if the destination does not already - exist in the specified directory bucket. If the object does exist when - you send a request with `If-None-Match:*`, the S3 API will return a `412 - Precondition Failed` error, preventing an overwrite. The `If-None-Match` - header prevents overwrites of existing data by validating that there''s - not an object with the same key name already in your directory bucket. - - - Expects the `*` character (asterisk).' - DestinationIfModifiedSince: - $ref: '#/components/schemas/IfModifiedSince' - description: Renames the object if the destination exists and if it has - been modified since the specified time. - DestinationIfUnmodifiedSince: - $ref: '#/components/schemas/IfUnmodifiedSince' - description: Renames the object if it hasn't been modified since the specified - time. - SourceIfMatch: - $ref: '#/components/schemas/RenameSourceIfMatch' - description: Renames the object if the source exists and if its entity tag - (ETag) matches the specified ETag. - SourceIfNoneMatch: - $ref: '#/components/schemas/RenameSourceIfNoneMatch' - description: Renames the object if the source exists and if its entity tag - (ETag) is different than the specified ETag. If an asterisk (`*`) character - is provided, the operation will fail and return a `412 Precondition Failed` - error. - SourceIfModifiedSince: - $ref: '#/components/schemas/RenameSourceIfModifiedSince' - description: Renames the object if the source exists and if it has been - modified since the specified time. - SourceIfUnmodifiedSince: - $ref: '#/components/schemas/RenameSourceIfUnmodifiedSince' - description: Renames the object if the source exists and hasn't been modified - since the specified time. - ClientToken: - $ref: '#/components/schemas/ClientToken' - description: 'A unique string with a max of 64 ASCII characters in the ASCII - range of 33 - 126. - - - `RenameObject` supports idempotency using a client token. To make an idempotent - API request using `RenameObject`, specify a client token in the request. - You should not reuse the same client token for other API requests. If - you retry a request that completed successfully using the same client - token and the same parameters, the retry succeeds without performing any - further actions. If you retry a successful request using the same client - token, but one or more of the parameters are different, the retry fails - and an `IdempotentParameterMismatch` error is returned.' - required: - - Bucket - - Key - - RenameSource - RenameSource: - type: string - pattern: ^\/?.+\/.+$ - RenameSourceIfMatch: - type: string - RenameSourceIfModifiedSince: - type: string - format: date-time - RenameSourceIfNoneMatch: - type: string - RenameSourceIfUnmodifiedSince: - type: string - format: date-time - ReplaceKeyPrefixWith: - type: string - ReplaceKeyWith: - type: string - ReplicaKmsKeyID: - type: string - ReplicaModifications: - type: object - properties: - Status: - $ref: '#/components/schemas/ReplicaModificationsStatus' - description: Specifies whether Amazon S3 replicates modifications on replicas. - required: - - Status - description: 'A filter that you can specify for selection for modifications - on replicas. Amazon S3 doesn''t replicate replica modifications by default. - In the latest version of replication configuration (when `Filter` is specified), - you can specify this element and set the status to `Enabled` to replicate - modifications on replicas. - - - If you don''t specify the `Filter` element, Amazon S3 assumes that the replication - configuration is the earlier version, V1. In the earlier version, this element - is not allowed.' - ReplicaModificationsStatus: - type: string - enum: - - Enabled - - Disabled - ReplicationConfiguration: - type: object - properties: - Role: - $ref: '#/components/schemas/Role' - description: The Amazon Resource Name (ARN) of the Identity and Access Management - (IAM) role that Amazon S3 assumes when replicating objects. For more information, - see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) - in the _Amazon S3 User Guide_. - Rules: - $ref: '#/components/schemas/ReplicationRules' - description: A container for one or more replication rules. A replication - configuration must have at least one rule and can contain a maximum of - 1,000 rules. - required: - - Role - - Rules - description: A container for replication rules. You can add up to 1,000 rules. - The maximum size of a replication configuration is 2 MB. - ReplicationRule: - type: object - properties: - ID: - $ref: '#/components/schemas/ID' - description: A unique identifier for the rule. The maximum value is 255 - characters. - Priority: - $ref: '#/components/schemas/Priority' - description: 'The priority indicates which rule has precedence whenever - two or more replication rules conflict. Amazon S3 will attempt to replicate - objects according to all replication rules. However, if there are two - or more rules with the same destination bucket, then objects will be replicated - according to the rule with the highest priority. The higher the number, - the higher the priority. - - - For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) - in the _Amazon S3 User Guide_.' - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'An object key name prefix that identifies the object or objects - to which the rule applies. The maximum prefix length is 1,024 characters. - To include all objects in a bucket, specify an empty string. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - Filter: - $ref: '#/components/schemas/ReplicationRuleFilter' - Status: - $ref: '#/components/schemas/ReplicationRuleStatus' - description: Specifies whether the rule is enabled. - SourceSelectionCriteria: - $ref: '#/components/schemas/SourceSelectionCriteria' - description: A container that describes additional filters for identifying - the source objects that you want to replicate. You can choose to enable - or disable the replication of these objects. Currently, Amazon S3 supports - only the filter that you can specify for objects created with server-side - encryption using a customer managed key stored in Amazon Web Services - Key Management Service (SSE-KMS). - ExistingObjectReplication: - $ref: '#/components/schemas/ExistingObjectReplication' - description: 'Optional configuration to replicate existing source bucket - objects. - - - This parameter is no longer supported. To replicate existing objects, - see [Replicating existing objects with S3 Batch Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html) - in the _Amazon S3 User Guide_.' - Destination: - $ref: '#/components/schemas/Destination' - description: A container for information about the replication destination - and its configurations including enabling the S3 Replication Time Control - (S3 RTC). - DeleteMarkerReplication: - $ref: '#/components/schemas/DeleteMarkerReplication' - required: - - Status - - Destination - description: Specifies which Amazon S3 objects to replicate and where to store - the replicas. - ReplicationRuleAndOperator: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: An object key name prefix that identifies the subset of objects - to which the rule applies. - Tags: - $ref: '#/components/schemas/TagSet' - description: An array of tags containing key and value pairs. - description: "A container for specifying rule filters. The filters determine\ - \ the subset of objects to which the rule applies. This element is required\ - \ only if you specify more than one filter.\n\nFor example:\n\n * If you\ - \ specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And`\ - \ tag. \n\n * If you specify a filter based on multiple tags, wrap the `Tag`\ - \ elements in an `And` tag." - ReplicationRuleFilter: - type: object - properties: - Prefix: - $ref: '#/components/schemas/Prefix' - description: 'An object key name prefix that identifies the subset of objects - to which the rule applies. - - - Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' - Tag: - $ref: '#/components/schemas/Tag' - description: 'A container for specifying a tag key and value. - - - The rule applies only to objects that have the tag in their tag set.' - And: - $ref: '#/components/schemas/ReplicationRuleAndOperator' - description: "A container for specifying rule filters. The filters determine\ - \ the subset of objects to which the rule applies. This element is required\ - \ only if you specify more than one filter. For example:\n\n * If you\ - \ specify both a `Prefix` and a `Tag` filter, wrap these filters in an\ - \ `And` tag.\n\n * If you specify a filter based on multiple tags, wrap\ - \ the `Tag` elements in an `And` tag." - description: A filter that identifies the subset of objects to which the replication - rule applies. A `Filter` must specify exactly one `Prefix`, `Tag`, or an `And` - child element. - ReplicationRuleStatus: - type: string - enum: - - Enabled - - Disabled - ReplicationRules: - type: array - items: - $ref: '#/components/schemas/ReplicationRule' - ReplicationStatus: - type: string - enum: - - COMPLETE - - PENDING - - FAILED - - REPLICA - - COMPLETED - ReplicationTime: - type: object - properties: - Status: - $ref: '#/components/schemas/ReplicationTimeStatus' - description: Specifies whether the replication time is enabled. - Time: - $ref: '#/components/schemas/ReplicationTimeValue' - description: A container specifying the time by which replication should - be complete for all objects and operations on objects. - required: - - Status - - Time - description: A container specifying S3 Replication Time Control (S3 RTC) related - information, including whether S3 RTC is enabled and the time when all objects - and operations on objects must be replicated. Must be specified together with - a `Metrics` block. - ReplicationTimeStatus: - type: string - enum: - - Enabled - - Disabled - ReplicationTimeValue: - type: object - properties: - Minutes: - $ref: '#/components/schemas/Minutes' - description: 'Contains an integer specifying time in minutes. - - - Valid value: 15' - description: A container specifying the time value for S3 Replication Time Control - (S3 RTC) and replication metrics `EventThreshold`. - RequestCharged: - type: string - enum: - - requester - description: "

If present, indicates that the requester was successfully charged\ - \ for the request. For more\n information, see Using Requester Pays buckets for storage transfers and usage in the Amazon\ - \ Simple\n Storage Service user guide.

\n \n \ - \

This functionality is not supported for directory buckets.

\n\ - \ " - RequestPayer: - type: string - enum: - - requester - description: "

Confirms that the requester knows that they will be charged\ - \ for the request. Bucket owners need not\n specify this parameter in\ - \ their requests. If either the source or destination S3 bucket has Requester\n\ - \ Pays enabled, the requester will pay for corresponding charges to copy\ - \ the object. For information about\n downloading objects from Requester\ - \ Pays buckets, see Downloading Objects in Requester Pays\n Buckets in the Amazon\ - \ S3 User Guide.

\n \n

This functionality\ - \ is not supported for directory buckets.

\n " - RequestPaymentConfiguration: - type: object - properties: - Payer: - $ref: '#/components/schemas/Payer' - description: Specifies who pays for the download and request fees. - required: - - Payer - description: Container for Payer. - RequestProgress: - type: object - properties: - Enabled: - $ref: '#/components/schemas/EnableRequestProgress' - description: 'Specifies whether periodic QueryProgress frames should be - sent. Valid values: TRUE, FALSE. Default value: FALSE.' - description: Container for specifying if periodic `QueryProgress` messages should - be sent. - RequestRoute: - type: string - RequestToken: - type: string - ResponseCacheControl: - type: string - ResponseContentDisposition: - type: string - ResponseContentEncoding: - type: string - ResponseContentLanguage: - type: string - ResponseContentType: - type: string - ResponseExpires: - type: string - format: date-time - Restore: - type: string - RestoreExpiryDate: - type: string - format: date-time - RestoreObjectOutput: - type: object - properties: - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - RestoreOutputPath: - $ref: '#/components/schemas/RestoreOutputPath' - description: Indicates the path in the provided S3 output location where - Select results will be restored to. - RestoreObjectRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: 'The bucket name containing the object to restore. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the action was initiated. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: VersionId used to reference a specific version of the object. - RestoreRequest: - $ref: '#/components/schemas/RestoreRequest' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - If you provide an individual checksum, Amazon S3 ignores any provided - `ChecksumAlgorithm` parameter.' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - RestoreOutputPath: - type: string - RestoreRequest: - type: object - properties: - Days: - $ref: '#/components/schemas/Days' - description: 'Lifetime of the active copy in days. Do not use with restores - that specify `OutputLocation`. - - - The Days element is required for regular restores, and must not be provided - for select requests.' - GlacierJobParameters: - $ref: '#/components/schemas/GlacierJobParameters' - description: S3 Glacier related parameters pertaining to this job. Do not - use with restores that specify `OutputLocation`. - Type: - $ref: '#/components/schemas/RestoreRequestType' - description: 'Amazon S3 Select is no longer available to new customers. - Existing customers of Amazon S3 Select can continue to use the feature - as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) - - - Type of restore request.' - Tier: - $ref: '#/components/schemas/Tier' - description: Retrieval tier at which the restore will be processed. - Description: - $ref: '#/components/schemas/Description' - description: The optional description for the job. - SelectParameters: - $ref: '#/components/schemas/SelectParameters' - description: 'Amazon S3 Select is no longer available to new customers. - Existing customers of Amazon S3 Select can continue to use the feature - as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) - - - Describes the parameters for Select job types.' - OutputLocation: - $ref: '#/components/schemas/OutputLocation' - description: Describes the location where the restore job's output is stored. - description: Container for restore job parameters. - RestoreRequestType: - type: string - enum: - - SELECT - RestoreStatus: - type: object - properties: - IsRestoreInProgress: - $ref: '#/components/schemas/IsRestoreInProgress' - description: 'Specifies whether the object is currently being restored. - If the object restoration is in progress, the header returns the value - `TRUE`. For example: - - - `x-amz-optional-object-attributes: IsRestoreInProgress="true"` - - - If the object restoration has completed, the header returns the value - `FALSE`. For example: - - - `x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"` - - - If the object hasn''t been restored, there is no header response.' - RestoreExpiryDate: - $ref: '#/components/schemas/RestoreExpiryDate' - description: '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"`' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) - in the _Amazon S3 User Guide_. - - - This functionality is not supported for directory buckets. Directory buckets - only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in - Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage - class) in Dedicated Local Zones.' - Role: - type: string - RoutingRule: - type: object - properties: - Condition: - $ref: '#/components/schemas/Condition' - description: A container for describing a condition that must be met for - the specified redirect to apply. For example, 1. If request is for pages - in the `/docs` folder, redirect to the `/documents` folder. 2. If request - results in HTTP error 4xx, redirect request to another host where you - might process the error. - Redirect: - $ref: '#/components/schemas/Redirect' - description: Container for redirect information. You can redirect requests - to another host, to another page, or with another protocol. In the event - of an error, you can specify a different error code to return. - required: - - Redirect - description: Specifies the redirect behavior and when a redirect is applied. - For more information about routing rules, see [Configuring advanced conditional - redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) - in the _Amazon S3 User Guide_. - RoutingRules: - type: array - items: - $ref: '#/components/schemas/RoutingRule' - S3KeyFilter: - type: object - properties: - FilterRules: - $ref: '#/components/schemas/FilterRuleList' - description: A container for object key name prefix and suffix filtering rules. - S3Location: - type: object - properties: - BucketName: - $ref: '#/components/schemas/BucketName' - description: The name of the bucket where the restore results will be placed. - Prefix: - $ref: '#/components/schemas/LocationPrefix' - description: The prefix that is prepended to the restore results for this - request. - Encryption: - $ref: '#/components/schemas/Encryption' - CannedACL: - $ref: '#/components/schemas/ObjectCannedACL' - description: The canned ACL to apply to the restore results. - AccessControlList: - $ref: '#/components/schemas/Grants' - description: A list of grants that control access to the staged results. - Tagging: - $ref: '#/components/schemas/Tagging' - description: The tag-set that is applied to the restore results. - UserMetadata: - $ref: '#/components/schemas/UserMetadata' - description: A list of metadata to store with the restore results in S3. - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: The class of storage used to store the restore results. - required: - - BucketName - - Prefix - description: Describes an Amazon S3 location that will receive the results of - the restore request. - S3RegionalOrS3ExpressBucketArnString: - type: string - pattern: '^arn:[^:]+:(s3|s3express):' - minLength: 1 - maxLength: 128 - S3TablesArn: - type: string - S3TablesBucketArn: - type: string - S3TablesBucketType: - type: string - enum: - - aws - - customer - S3TablesDestination: - type: object - properties: - TableBucketArn: - $ref: '#/components/schemas/S3TablesBucketArn' - description: The Amazon Resource Name (ARN) for the table bucket that's - specified as the destination in the metadata table configuration. The - destination table bucket must be in the same Region and Amazon Web Services - account as the general purpose bucket. - TableName: - $ref: '#/components/schemas/S3TablesName' - description: The name for the metadata table in your metadata table configuration. - The specified metadata table name must be unique within the `aws_s3_metadata` - namespace in the destination table bucket. - required: - - TableBucketArn - - TableName - description: 'The destination information for a V1 S3 Metadata configuration. - The destination table bucket must be in the same Region and Amazon Web Services - account as the general purpose bucket. The specified metadata table name must - be unique within the `aws_s3_metadata` namespace in the destination table - bucket. - - - If you created your S3 Metadata configuration before July 15, 2025, we recommend - that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) - so that you can expire journal table records and create a live inventory table.' - S3TablesDestinationResult: - type: object - properties: - TableBucketArn: - $ref: '#/components/schemas/S3TablesBucketArn' - description: The Amazon Resource Name (ARN) for the table bucket that's - specified as the destination in the metadata table configuration. The - destination table bucket must be in the same Region and Amazon Web Services - account as the general purpose bucket. - TableName: - $ref: '#/components/schemas/S3TablesName' - description: The name for the metadata table in your metadata table configuration. - The specified metadata table name must be unique within the `aws_s3_metadata` - namespace in the destination table bucket. - TableArn: - $ref: '#/components/schemas/S3TablesArn' - description: The Amazon Resource Name (ARN) for the metadata table in the - metadata table configuration. The specified metadata table name must be - unique within the `aws_s3_metadata` namespace in the destination table - bucket. - TableNamespace: - $ref: '#/components/schemas/S3TablesNamespace' - description: The table bucket namespace for the metadata table in your metadata - table configuration. This value is always `aws_s3_metadata`. - required: - - TableBucketArn - - TableName - - TableArn - - TableNamespace - description: 'The destination information for a V1 S3 Metadata configuration. - The destination table bucket must be in the same Region and Amazon Web Services - account as the general purpose bucket. The specified metadata table name must - be unique within the `aws_s3_metadata` namespace in the destination table - bucket. - - - If you created your S3 Metadata configuration before July 15, 2025, we recommend - that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) - so that you can expire journal table records and create a live inventory table.' - S3TablesName: - type: string - S3TablesNamespace: - type: string - SSECustomerAlgorithm: - type: string - SSECustomerKey: - type: string - SSECustomerKeyMD5: - type: string - SSEKMS: - type: object - properties: - KeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: Specifies the ID of the Key Management Service (KMS) symmetric - encryption customer managed key to use for encrypting inventory reports. - required: - - KeyId - description: Specifies the use of SSE-KMS to encrypt delivered inventory reports. - SSEKMSEncryptionContext: - type: string - SSEKMSKeyId: - type: string - SSES3: - type: object - properties: {} - description: Specifies the use of SSE-S3 to encrypt delivered inventory reports. - ScanRange: - type: object - properties: - Start: - $ref: '#/components/schemas/Start' - description: 'Specifies the start of the byte range. This parameter is optional. - Valid values: non-negative integers. The default value is 0. If only `start` - is supplied, it means scan from that point to the end of the file. For - example, `50` means scan from byte 50 until the end of the file.' - End: - $ref: '#/components/schemas/End' - description: 'Specifies the end of the byte range. This parameter is optional. - Valid values: non-negative integers. The default value is one less than - the size of the object being queried. If only the End parameter is supplied, - it is interpreted to mean scan the last N bytes of the file. For example, - `50` means scan the last 50 bytes.' - description: Specifies the byte range of the object to get the records from. - A record is processed when its first byte is contained by the range. This - parameter is optional, but when specified, it must not be empty. See RFC 2616, - Section 14.35.1 about how to specify the start and end of the range. - SelectObjectContentEventStream: - allOf: - - $ref: '#/components/schemas/RecordsEvent' - description: |- - The Records Event. - - $ref: '#/components/schemas/StatsEvent' - description: |- - The Stats Event. - - $ref: '#/components/schemas/ProgressEvent' - description: |- - The Progress Event. - - $ref: '#/components/schemas/ContinuationEvent' - description: |- - The Continuation Event. - - $ref: '#/components/schemas/EndEvent' - description: |- - The End Event. - description: |- - The container for selecting objects from a content event stream. - SelectObjectContentOutput: - type: object - properties: - Payload: - $ref: '#/components/schemas/SelectObjectContentEventStream' - description: The array of results. - SelectObjectContentRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The S3 bucket. - Key: - $ref: '#/components/schemas/ObjectKey' - description: The object key. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) - in the _Amazon S3 User Guide_. - Expression: - $ref: '#/components/schemas/Expression' - description: The expression that is used to query the object. - ExpressionType: - $ref: '#/components/schemas/ExpressionType' - description: The type of the provided expression (for example, SQL). - RequestProgress: - $ref: '#/components/schemas/RequestProgress' - description: Specifies if periodic request progress information should be - enabled. - InputSerialization: - $ref: '#/components/schemas/InputSerialization' - description: Describes the format of the data in the object that is being - queried. - OutputSerialization: - $ref: '#/components/schemas/OutputSerialization' - description: Describes the format of the data that you want Amazon S3 to - return in response. - ScanRange: - $ref: '#/components/schemas/ScanRange' - description: "Specifies the byte range of the object to get the records\ - \ from. A record is processed when its first byte is contained by the\ - \ range. This parameter is optional, but when specified, it must not be\ - \ empty. See RFC 2616, Section 14.35.1 about how to specify the start\ - \ and end of the range.\n\n`ScanRange`may be used in the following ways:\n\ - \n * `50100` \\- process only the records starting between the bytes\ - \ 50 and 100 (inclusive, counting from zero)\n\n * `50` \\- process only\ - \ the records starting after the byte 50\n\n * `50` \\- process only\ - \ the records within the last 50 bytes of the file." - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - - Expression - - ExpressionType - - InputSerialization - - OutputSerialization - description: 'Learn Amazon S3 Select is no longer available to new customers. - Existing customers of Amazon S3 Select can continue to use the feature as - usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) - - - Request to filter 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 specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records. It returns only records - that match the specified SQL expression. You must also specify the data serialization - format for the response. For more information, see [S3Select API Documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html).' - SelectParameters: - type: object - properties: - InputSerialization: - $ref: '#/components/schemas/InputSerialization' - description: Describes the serialization format of the object. - ExpressionType: - $ref: '#/components/schemas/ExpressionType' - description: The type of the provided expression (for example, SQL). - Expression: - $ref: '#/components/schemas/Expression' - description: 'Amazon S3 Select is no longer available to new customers. - Existing customers of Amazon S3 Select can continue to use the feature - as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) - - - The expression that is used to query the object.' - OutputSerialization: - $ref: '#/components/schemas/OutputSerialization' - description: Describes how the results of the Select job are serialized. - required: - - InputSerialization - - ExpressionType - - Expression - - OutputSerialization - description: 'Amazon S3 Select is no longer available to new customers. Existing - customers of Amazon S3 Select can continue to use the feature as usual. [Learn - more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) - - - Describes the parameters for Select job types. - - - Learn [How to optimize querying your data in Amazon S3](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) - using [Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/what-is.html), - [S3 Object Lambda](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html), - or client-side filtering.' - ServerSideEncryption: - type: string - enum: - - AES256 - - aws:fsx - - aws:kms - - aws:kms:dsse - ServerSideEncryptionByDefault: - type: object - properties: - SSEAlgorithm: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'Server-side encryption algorithm to use for the default encryption. - - - For directory buckets, there are only two supported values for server-side - encryption: `AES256` and `aws:kms`.' - KMSMasterKeyID: - $ref: '#/components/schemas/SSEKMSKeyId' - description: "Amazon Web Services Key Management Service (KMS) customer\ - \ managed key ID to use for the default encryption.\n\n * **General purpose\ - \ buckets** \\- This parameter is allowed if and only if `SSEAlgorithm`\ - \ is set to `aws:kms` or `aws:kms:dsse`.\n\n * **Directory buckets**\ - \ \\- This parameter is allowed if and only if `SSEAlgorithm` is set to\ - \ `aws:kms`.\n\nYou can specify the key ID, key alias, or the Amazon Resource\ - \ Name (ARN) of the KMS key.\n\n * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n\ - \n * Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n\ - \n * Key Alias: `alias/alias-name`\n\nIf you are using encryption with\ - \ cross-account or Amazon Web Services service operations, you must use\ - \ a fully qualified KMS key ARN. For more information, see [Using encryption\ - \ for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n\ - \n * **General purpose buckets** \\- If you're specifying a customer\ - \ managed KMS key, we recommend using a fully qualified KMS key ARN. If\ - \ you use a KMS key alias instead, then KMS resolves the key within the\ - \ requester’s account. This behavior can result in data that's encrypted\ - \ with a KMS key that belongs to the requester, and not the bucket owner.\ - \ Also, if you use a key ID, you can run into a LogDestination undeliverable\ - \ error when creating a VPC flow log. \n\n * **Directory buckets** \\\ - - When you specify an [KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ for encryption in your directory bucket, only use the key ID or key\ - \ ARN. The key alias format of the KMS key isn't supported.\n\nAmazon\ - \ S3 only supports symmetric encryption KMS keys. For more information,\ - \ see [Asymmetric keys in Amazon Web Services KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)\ - \ in the _Amazon Web Services Key Management Service Developer Guide_." - required: - - SSEAlgorithm - description: "Describes the default server-side encryption to apply to new objects\ - \ in the bucket. If a PUT Object request doesn't specify any server-side encryption,\ - \ this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html).\n\ - \n * **General purpose buckets** \\- If you don't specify a customer managed\ - \ key at configuration, Amazon S3 automatically creates an Amazon Web Services\ - \ KMS key (`aws/s3`) in your Amazon Web Services account the first time that\ - \ you add an object encrypted with SSE-KMS to a bucket. By default, Amazon\ - \ S3 uses this KMS key for SSE-KMS. \n\n * **Directory buckets** \\- Your\ - \ SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ per directory bucket's lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\ - \ (`aws/s3`) isn't supported. \n\n * **Directory buckets** \\- For directory\ - \ buckets, there are only two supported options for server-side encryption:\ - \ SSE-S3 and SSE-KMS." - ServerSideEncryptionConfiguration: - type: object - properties: - Rules: - $ref: '#/components/schemas/ServerSideEncryptionRules' - description: Container for information about a particular server-side encryption - configuration rule. - required: - - Rules - description: Specifies the default server-side-encryption configuration. - ServerSideEncryptionRule: - type: object - properties: - ApplyServerSideEncryptionByDefault: - $ref: '#/components/schemas/ServerSideEncryptionByDefault' - description: Specifies the default server-side encryption to apply to new - objects in the bucket. If a PUT Object request doesn't specify any server-side - encryption, this default encryption will be applied. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: "Specifies whether Amazon S3 should use an S3 Bucket Key with\ - \ server-side encryption using KMS (SSE-KMS) for new objects in the bucket.\ - \ Existing objects are not affected. Setting the `BucketKeyEnabled` element\ - \ to `true` causes Amazon S3 to use an S3 Bucket Key.\n\n * **General\ - \ purpose buckets** \\- By default, S3 Bucket Key is not enabled. For\ - \ more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html)\ - \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- S3 Bucket\ - \ Keys are always enabled for `GET` and `PUT` operations in a directory\ - \ bucket and can’t be disabled. S3 Bucket Keys aren't supported, when\ - \ you copy SSE-KMS encrypted objects from general purpose buckets to directory\ - \ buckets, from directory buckets to general purpose buckets, or between\ - \ directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html),\ - \ [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html),\ - \ [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops),\ - \ or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job).\ - \ In this case, Amazon S3 makes a call to KMS every time a copy request\ - \ is made for a KMS-encrypted object." - BlockedEncryptionTypes: - $ref: '#/components/schemas/BlockedEncryptionTypes' - description: 'A bucket-level setting for Amazon S3 general purpose buckets - used to prevent the upload of new objects encrypted with the specified - server-side encryption type. For example, blocking an encryption type - will block `PutObject`, `CopyObject`, `PostObject`, multipart upload, - and replication requests to the bucket for objects with the specified - encryption type. However, you can continue to read and list any pre-existing - objects already encrypted with the specified encryption type. For more - information, see [Blocking or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html). - - - Currently, this parameter only supports blocking or unblocking server-side - encryption with customer-provided keys (SSE-C). For more information about - SSE-C, see [Using server-side encryption with customer-provided keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).' - description: "Specifies the default server-side encryption configuration.\n\n\ - \ * **General purpose buckets** \\- If you're specifying a customer managed\ - \ KMS key, we recommend using a fully qualified KMS key ARN. If you use a\ - \ KMS key alias instead, then KMS resolves the key within the requester’s\ - \ account. This behavior can result in data that's encrypted with a KMS key\ - \ that belongs to the requester, and not the bucket owner.\n\n * **Directory\ - \ buckets** \\- When you specify an [KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ - \ for encryption in your directory bucket, only use the key ID or key ARN.\ - \ The key alias format of the KMS key isn't supported." - ServerSideEncryptionRules: - type: array - items: - $ref: '#/components/schemas/ServerSideEncryptionRule' - SessionCredentialValue: - type: string - SessionCredentials: - type: object - properties: - AccessKeyId: - $ref: '#/components/schemas/AccessKeyIdValue' - description: 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. - SecretAccessKey: - $ref: '#/components/schemas/SessionCredentialValue' - description: 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. - SessionToken: - $ref: '#/components/schemas/SessionCredentialValue' - description: A part of the temporary security credentials. The session token - is used to validate the temporary security credentials. - Expiration: - $ref: '#/components/schemas/SessionExpiration' - description: 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. - required: - - AccessKeyId - - SecretAccessKey - - SessionToken - - Expiration - description: 'The established temporary security credentials of the session. - - - **Directory buckets** \- These session credentials are only supported for - the authentication and authorization of Zonal endpoint API operations on directory - buckets.' - SessionExpiration: - type: string - format: date-time - SessionMode: - type: string - enum: - - ReadOnly - - ReadWrite - Setting: - type: boolean - SimplePrefix: - type: object - properties: {} - description: 'To use simple format for S3 keys for log objects, set SimplePrefix - to an empty object. - - - `[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`' - Size: - type: integer - format: int64 - SkipValidation: - type: boolean - SourceSelectionCriteria: - type: object - properties: - SseKmsEncryptedObjects: - $ref: '#/components/schemas/SseKmsEncryptedObjects' - description: A container for filter information for the selection of Amazon - S3 objects encrypted with Amazon Web Services KMS. If you include `SourceSelectionCriteria` - in the replication configuration, this element is required. - ReplicaModifications: - $ref: '#/components/schemas/ReplicaModifications' - description: 'A filter that you can specify for selections for modifications - on replicas. Amazon S3 doesn''t replicate replica modifications by default. - In the latest version of replication configuration (when `Filter` is specified), - you can specify this element and set the status to `Enabled` to replicate - modifications on replicas. - - - If you don''t specify the `Filter` element, Amazon S3 assumes that the - replication configuration is the earlier version, V1. In the earlier version, - this element is not allowed' - description: A container that describes additional filters for identifying the - source objects that you want to replicate. You can choose to enable or disable - the replication of these objects. Currently, Amazon S3 supports only the filter - that you can specify for objects created with server-side encryption using - a customer managed key stored in Amazon Web Services Key Management Service - (SSE-KMS). - SseKmsEncryptedObjects: - type: object - properties: - Status: - $ref: '#/components/schemas/SseKmsEncryptedObjectsStatus' - description: Specifies whether Amazon S3 replicates objects created with - server-side encryption using an Amazon Web Services KMS key stored in - Amazon Web Services Key Management Service. - required: - - Status - description: A container for filter information for the selection of S3 objects - encrypted with Amazon Web Services KMS. - SseKmsEncryptedObjectsStatus: - type: string - enum: - - Enabled - - Disabled - Start: - type: integer - format: int64 - StartAfter: - type: string - Stats: - type: object - properties: - BytesScanned: - $ref: '#/components/schemas/BytesScanned' - description: The total number of object bytes scanned. - BytesProcessed: - $ref: '#/components/schemas/BytesProcessed' - description: The total number of uncompressed object bytes processed. - BytesReturned: - $ref: '#/components/schemas/BytesReturned' - description: The total number of bytes of records payload data returned. - description: Container for the stats details. - StatsEvent: - type: object - properties: - Details: - $ref: '#/components/schemas/Stats' - description: The Stats event details. - description: Container for the Stats Event. - StorageClass: - type: string - enum: - - STANDARD - - REDUCED_REDUNDANCY - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - - SNOW - - EXPRESS_ONEZONE - - FSX_OPENZFS - - FSX_ONTAP - StorageClassAnalysis: - type: object - properties: - DataExport: - $ref: '#/components/schemas/StorageClassAnalysisDataExport' - description: Specifies how data related to the storage class analysis for - an Amazon S3 bucket should be exported. - description: Specifies data related to access patterns to be collected and made - available to analyze the tradeoffs between different storage classes for an - Amazon S3 bucket. - StorageClassAnalysisDataExport: - type: object - properties: - OutputSchemaVersion: - $ref: '#/components/schemas/StorageClassAnalysisSchemaVersion' - description: The version of the output schema to use when exporting data. - Must be `V_1`. - Destination: - $ref: '#/components/schemas/AnalyticsExportDestination' - description: The place to store the data for an analysis. - required: - - OutputSchemaVersion - - Destination - description: Container for data related to the storage class analysis for an - Amazon S3 bucket for export. - StorageClassAnalysisSchemaVersion: - type: string - enum: - - V_1 - StreamingBlob: - type: string - format: byte - Suffix: - type: string - TableSseAlgorithm: - type: string - enum: - - aws:kms - - AES256 - Tag: - type: object - properties: - Key: - $ref: '#/components/schemas/ObjectKey' - description: Name of the object key. - Value: - $ref: '#/components/schemas/Value' - description: Value of the tag. - required: - - Key - - Value - description: A container of a key value name pair. - TagCount: - type: integer - TagSet: - type: array - items: - $ref: '#/components/schemas/Tag' - Tagging: - type: object - properties: - TagSet: - $ref: '#/components/schemas/TagSet' - description: A collection for a set of tags - required: - - TagSet - description: Container for `TagSet` elements. - TaggingDirective: - type: string - enum: - - COPY - - REPLACE - TaggingHeader: - type: string - TargetBucket: - type: string - TargetGrant: - type: object - properties: - Grantee: - $ref: '#/components/schemas/Grantee' - description: Container for the person being granted permissions. - Permission: - $ref: '#/components/schemas/BucketLogsPermission' - description: Logging permissions assigned to the grantee for the bucket. - description: 'Container for granting information. - - - Buckets that use the bucket owner enforced setting for Object Ownership don''t - support target grants. For more information, see [Permissions server access - log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) - in the _Amazon S3 User Guide_.' - TargetGrants: - type: array - items: - $ref: '#/components/schemas/TargetGrant' - TargetObjectKeyFormat: - type: object - properties: - SimplePrefix: - $ref: '#/components/schemas/SimplePrefix' - description: To use the simple format for S3 keys for log objects. To specify - SimplePrefix format, set SimplePrefix to {}. - PartitionedPrefix: - $ref: '#/components/schemas/PartitionedPrefix' - description: Partitioned S3 key for log objects. - description: Amazon S3 key format for log objects. Only one format, PartitionedPrefix - or SimplePrefix, is allowed. - TargetPrefix: - type: string - Tier: - type: string - enum: - - Standard - - Bulk - - Expedited - Tiering: - type: object - properties: - Days: - $ref: '#/components/schemas/IntelligentTieringDays' - description: The number of consecutive days of no access after which an - object will be eligible to be transitioned to the corresponding tier. - The minimum number of days specified for Archive Access tier must be at - least 90 days and Deep Archive Access tier must be at least 180 days. - The maximum can be up to 2 years (730 days). - AccessTier: - $ref: '#/components/schemas/IntelligentTieringAccessTier' - description: S3 Intelligent-Tiering access tier. See [Storage class for - automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) - for a list of access tiers in the S3 Intelligent-Tiering storage class. - required: - - Days - - AccessTier - description: 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 additional operational overhead. - TieringList: - type: array - items: - $ref: '#/components/schemas/Tiering' - Token: - type: string - TooManyParts: - type: object - properties: {} - description: You have attempted to add more parts than the maximum of 10000 - that are allowed for this object. You can use the CopyObject operation to - copy this object to another and then add more data to the newly copied object. - TopicArn: - type: string - TopicConfiguration: - type: object - properties: - Id: - $ref: '#/components/schemas/NotificationId' - TopicArn: - $ref: '#/components/schemas/TopicArn' - description: The Amazon Resource Name (ARN) of the Amazon SNS topic to which - Amazon S3 publishes a message when it detects events of the specified - type. - Events: - $ref: '#/components/schemas/EventList' - description: The Amazon S3 bucket event about which to send notifications. - For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) - in the _Amazon S3 User Guide_. - Filter: - $ref: '#/components/schemas/NotificationConfigurationFilter' - required: - - TopicArn - - Events - description: A container for specifying the configuration for publication of - messages to an Amazon Simple Notification Service (Amazon SNS) topic when - Amazon S3 detects specified events. - TopicConfigurationList: - type: array - items: - $ref: '#/components/schemas/TopicConfiguration' - Transition: - type: object - properties: - Date: - $ref: '#/components/schemas/Date' - description: Indicates when objects are transitioned to the specified storage - class. The date value must be in ISO 8601 format. The time is always midnight - UTC. - Days: - $ref: '#/components/schemas/Days' - description: Indicates the number of days after creation when objects are - transitioned to the specified storage class. If the specified storage - class is `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE`, - valid values are `0` or positive integers. If the specified storage class - is `STANDARD_IA` or `ONEZONE_IA`, valid values are positive integers greater - than `30`. Be aware that some storage classes have a minimum storage duration - and that you're charged for transitioning objects before their minimum - storage duration. For more information, see [ Constraints and considerations - for transitions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-transition-general-considerations.html#lifecycle-configuration-constraints) - in the _Amazon S3 User Guide_. - StorageClass: - $ref: '#/components/schemas/TransitionStorageClass' - description: The storage class to which you want the object to transition. - description: Specifies when an object transitions to a specified storage class. - For more information about Amazon S3 lifecycle configuration rules, see [Transitioning - Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) - in the _Amazon S3 User Guide_. - TransitionDefaultMinimumObjectSize: - type: string - enum: - - varies_by_storage_class - - all_storage_classes_128K - TransitionList: - type: array - items: - $ref: '#/components/schemas/Transition' - TransitionStorageClass: - type: string - enum: - - GLACIER - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - DEEP_ARCHIVE - - GLACIER_IR - Type: - type: string - enum: - - CanonicalUser - - AmazonCustomerByEmail - - Group - URI: - type: string - UpdateBucketMetadataInventoryTableConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that corresponds to the metadata - configuration that you want to enable or disable an inventory table for. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: The `Content-MD5` header for the inventory table configuration. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The checksum algorithm to use with your inventory table configuration. - InventoryTableConfiguration: - $ref: '#/components/schemas/InventoryTableConfigurationUpdates' - description: The contents of your inventory table configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected owner of the general purpose bucket that corresponds - to the metadata table configuration that you want to enable or disable - an inventory table for. - required: - - Bucket - - InventoryTableConfiguration - UpdateBucketMetadataJournalTableConfigurationRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: The general purpose bucket that corresponds to the metadata - configuration that you want to enable or disable journal table record - expiration for. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: The `Content-MD5` header for the journal table configuration. - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: The checksum algorithm to use with your journal table configuration. - JournalTableConfiguration: - $ref: '#/components/schemas/JournalTableConfigurationUpdates' - description: The contents of your journal table configuration. - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: The expected owner of the general purpose bucket that corresponds - to the metadata table configuration that you want to enable or disable - journal table record expiration for. - required: - - Bucket - - JournalTableConfiguration - UploadIdMarker: - type: string - UploadPartCopyOutput: - type: object - properties: - CopySourceVersionId: - $ref: '#/components/schemas/CopySourceVersionId' - description: '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.' - CopyPartResult: - $ref: '#/components/schemas/CopyPartResult' - description: Container for all response elements. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the multipart upload uses an S3 Bucket Key - for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - UploadPartCopyRequest: - type: object - properties: - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - Copying objects across different Amazon Web Services Regions isn''t supported - when the source or destination bucket is in Amazon Web Services Local - Zones. The source and destination buckets must have the same parent Amazon - Web Services Region. Otherwise, you get an HTTP `400 Bad Request` error - with the error code `InvalidRequest`. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - CopySource: - $ref: '#/components/schemas/CopySource' - description: "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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):\n\ - \n * 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.\n\n * 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:::accesspoint//object/`.\ - \ 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.\n\n * Amazon S3 supports copy operations\ - \ using Access points only when the source and destination buckets are\ - \ in the same Amazon Web Services Region.\n\n * Access points are not\ - \ supported by directory buckets.\n\nAlternatively, for objects accessed\ - \ through Amazon S3 on Outposts, specify the ARN of the object as accessed\ - \ in the format `arn:aws:s3-outposts:::outpost//object/`. 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.\n\nIf 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=`\ - \ to the `x-amz-copy-source` request header (for example, `x-amz-copy-source:\ - \ /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`).\n\ - \nIf 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`.\n\ - \n**Directory buckets** \\- S3 Versioning isn't enabled and supported\ - \ for directory buckets." - CopySourceIfMatch: - $ref: '#/components/schemas/CopySourceIfMatch' - description: '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.' - CopySourceIfModifiedSince: - $ref: '#/components/schemas/CopySourceIfModifiedSince' - description: '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.' - CopySourceIfNoneMatch: - $ref: '#/components/schemas/CopySourceIfNoneMatch' - description: '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.' - CopySourceIfUnmodifiedSince: - $ref: '#/components/schemas/CopySourceIfUnmodifiedSince' - description: '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.' - CopySourceRange: - $ref: '#/components/schemas/CopySourceRange' - description: The range of bytes to copy from the source object. The range - value must use the form bytes=first-last, where the first and last are - the zero-based byte offsets to copy. For example, bytes=0-9 indicates - that you want to copy the first 10 bytes of the source. You can copy a - range only if the source object is greater than 5 MB. - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload was initiated. - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: Part number of part being copied. This is a positive integer - between 1 and 10,000. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: Upload ID identifying the multipart upload whose part is being - copied. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - CopySourceSSECustomerAlgorithm: - $ref: '#/components/schemas/CopySourceSSECustomerAlgorithm' - description: '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.' - CopySourceSSECustomerKey: - $ref: '#/components/schemas/CopySourceSSECustomerKey' - description: '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.' - CopySourceSSECustomerKeyMD5: - $ref: '#/components/schemas/CopySourceSSECustomerKeyMD5' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - ExpectedSourceBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - CopySource - - Key - - PartNumber - - UploadId - UploadPartOutput: - type: object - properties: - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when you store this - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - ETag: - $ref: '#/components/schemas/ETag' - description: Entity tag for the uploaded object. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the - part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: The Base64 encoded, 160-bit `SHA1` digest of the object. This - checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: The Base64 encoded, 256-bit `SHA256` digest of the object. - This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) - in the _Amazon S3 User Guide_. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, indicates the ID of the KMS key that was used for - object encryption. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the multipart upload uses an S3 Bucket Key - for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - UploadPartRequest: - type: object - properties: - Body: - $ref: '#/components/schemas/StreamingBlob' - description: Object data. - Bucket: - $ref: '#/components/schemas/BucketName' - description: '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-_zone-id_._region-code_.amazonaws.com`. - Path-style requests are not supported. Directory bucket names must be - unique in the chosen Zone (Availability Zone or Local Zone). Bucket names - must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, - ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket - naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - in the _Amazon S3 User Guide_. - - - **Access points** \- When you use this action with an access point for - general purpose buckets, you must provide the alias of the access point - in place of the bucket name or specify the access point ARN. When you - use this action with an access point for directory buckets, you must provide - the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) - in the _Amazon S3 User Guide_. - - - Object Lambda access points are not supported by directory buckets. - - - **S3 on Outposts** \- When you use this action with 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, the destination bucket must - be the Outposts access point ARN or the access point alias. For more information - about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) - in the _Amazon S3 User Guide_.' - ContentLength: - $ref: '#/components/schemas/ContentLength' - description: Size of the body in bytes. This parameter is useful when the - size of the body cannot be determined automatically. - ContentMD5: - $ref: '#/components/schemas/ContentMD5' - description: '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.' - ChecksumAlgorithm: - $ref: '#/components/schemas/ChecksumAlgorithm' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - 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.' - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32` checksum of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the - part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 160-bit `SHA1` digest of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 256-bit `SHA256` digest of the object. - For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - Key: - $ref: '#/components/schemas/ObjectKey' - description: Object key for which the multipart upload was initiated. - PartNumber: - $ref: '#/components/schemas/PartNumber' - description: Part number of part being uploaded. This is a positive integer - between 1 and 10,000. - UploadId: - $ref: '#/components/schemas/MultipartUploadId' - description: Upload ID identifying the multipart upload whose part is being - uploaded. - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: 'Specifies the algorithm to use when encrypting the object - (for example, AES256). - - - This functionality is not supported for directory buckets.' - SSECustomerKey: - $ref: '#/components/schemas/SSECustomerKey' - description: '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.' - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: '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.' - RequestPayer: - $ref: '#/components/schemas/RequestPayer' - ExpectedBucketOwner: - $ref: '#/components/schemas/AccountId' - description: 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). - required: - - Bucket - - Key - - PartNumber - - UploadId - UserMetadata: - type: array - items: - $ref: '#/components/schemas/MetadataEntry' - Value: - type: string - VersionCount: - type: integer - VersionIdMarker: - type: string - VersioningConfiguration: - type: object - properties: - MFADelete: - $ref: '#/components/schemas/MFADelete' - description: Specifies whether MFA delete is enabled in the bucket versioning - configuration. This element is only returned if the bucket has been configured - with MFA delete. If the bucket has never been so configured, this element - is not returned. - Status: - $ref: '#/components/schemas/BucketVersioningStatus' - description: The versioning state of the bucket. - description: Describes the versioning state of an Amazon S3 bucket. For more - information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) - in the _Amazon S3 API Reference_. - WebsiteConfiguration: - type: object - properties: - ErrorDocument: - $ref: '#/components/schemas/ErrorDocument' - description: The name of the error document for the website. - IndexDocument: - $ref: '#/components/schemas/IndexDocument' - description: The name of the index document for the website. - RedirectAllRequestsTo: - $ref: '#/components/schemas/RedirectAllRequestsTo' - description: 'The redirect behavior for every request to this bucket''s - website endpoint. - - - If you specify this property, you can''t specify any other property.' - RoutingRules: - $ref: '#/components/schemas/RoutingRules' - description: Rules that define when a redirect is applied and the redirect - behavior. - description: Specifies website configuration parameters for an Amazon S3 bucket. - WebsiteRedirectLocation: - type: string - WriteGetObjectResponseRequest: - type: object - properties: - RequestRoute: - $ref: '#/components/schemas/RequestRoute' - description: Route prefix to the HTTP URL generated. - RequestToken: - $ref: '#/components/schemas/RequestToken' - description: A single use encrypted token that maps `WriteGetObjectResponse` - to the end user `GetObject` request. - Body: - $ref: '#/components/schemas/StreamingBlob' - description: The object data. - StatusCode: - $ref: '#/components/schemas/GetObjectResponseStatusCode' - description: "The integer status code for an HTTP response of a corresponding\ - \ `GetObject` request. The following is a list of status codes.\n\n *\ - \ `200 - OK`\n\n * `206 - Partial Content`\n\n * `304 - Not Modified`\n\ - \n * `400 - Bad Request`\n\n * `401 - Unauthorized`\n\n * `403 - Forbidden`\n\ - \n * `404 - Not Found`\n\n * `405 - Method Not Allowed`\n\n * `409\ - \ - Conflict`\n\n * `411 - Length Required`\n\n * `412 - Precondition\ - \ Failed`\n\n * `416 - Range Not Satisfiable`\n\n * `500 - Internal\ - \ Server Error`\n\n * `503 - Service Unavailable`" - ErrorCode: - $ref: '#/components/schemas/ErrorCode' - description: A string that uniquely identifies an error condition. Returned - in the ` tag of the error XML response for a corresponding `GetObject` - call. Cannot be used with a successful `StatusCode` header or when the - transformed object is provided in the body. All error codes from S3 are - sentence-cased. The regular expression (regex) value is `"^[A-Z][a-zA-Z]+$"`. - ErrorMessage: - $ref: '#/components/schemas/ErrorMessage' - description: Contains a generic description of the error condition. Returned - in the tag of the error XML response for a corresponding `GetObject` - call. Cannot be used with a successful `StatusCode` header or when the - transformed object is provided in body. - AcceptRanges: - $ref: '#/components/schemas/AcceptRanges' - description: Indicates that a range of bytes was specified. - CacheControl: - $ref: '#/components/schemas/CacheControl' - description: Specifies caching behavior along the request/reply chain. - ContentDisposition: - $ref: '#/components/schemas/ContentDisposition' - description: Specifies presentational information for the object. - ContentEncoding: - $ref: '#/components/schemas/ContentEncoding' - description: 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. - ContentLanguage: - $ref: '#/components/schemas/ContentLanguage' - description: The language the content is in. - ContentLength: - $ref: '#/components/schemas/ContentLength' - description: The size of the content body in bytes. - ContentRange: - $ref: '#/components/schemas/ContentRange' - description: The portion of the object returned in the response. - ContentType: - $ref: '#/components/schemas/ContentType' - description: A standard MIME type describing the format of the object data. - ChecksumCRC32: - $ref: '#/components/schemas/ChecksumCRC32' - description: 'This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - specifies the Base64 encoded, 32-bit `CRC32` checksum of the object returned - by the Object Lambda function. This may not match the checksum for the - object stored in Amazon S3. Amazon S3 will perform validation of the checksum - values only when the original `GetObject` request required checksum validation. - For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - Only one checksum header can be specified at a time. If you supply multiple - checksum headers, this request will fail.' - ChecksumCRC32C: - $ref: '#/components/schemas/ChecksumCRC32C' - description: 'This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object returned - by the Object Lambda function. This may not match the checksum for the - object stored in Amazon S3. Amazon S3 will perform validation of the checksum - values only when the original `GetObject` request required checksum validation. - For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - Only one checksum header can be specified at a time. If you supply multiple - checksum headers, this request will fail.' - ChecksumCRC64NVME: - $ref: '#/components/schemas/ChecksumCRC64NVME' - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the - part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - ChecksumSHA1: - $ref: '#/components/schemas/ChecksumSHA1' - description: 'This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - specifies the Base64 encoded, 160-bit `SHA1` digest of the object returned - by the Object Lambda function. This may not match the checksum for the - object stored in Amazon S3. Amazon S3 will perform validation of the checksum - values only when the original `GetObject` request required checksum validation. - For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - Only one checksum header can be specified at a time. If you supply multiple - checksum headers, this request will fail.' - ChecksumSHA256: - $ref: '#/components/schemas/ChecksumSHA256' - description: 'This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - specifies the Base64 encoded, 256-bit `SHA256` digest of the object returned - by the Object Lambda function. This may not match the checksum for the - object stored in Amazon S3. Amazon S3 will perform validation of the checksum - values only when the original `GetObject` request required checksum validation. - For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - in the _Amazon S3 User Guide_. - - - Only one checksum header can be specified at a time. If you supply multiple - checksum headers, this request will fail.' - DeleteMarker: - $ref: '#/components/schemas/DeleteMarker' - description: Specifies whether an object stored in Amazon S3 is (`true`) - or is not (`false`) a delete marker. To learn more about delete markers, - see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). - ETag: - $ref: '#/components/schemas/ETag' - description: An opaque identifier assigned by a web server to a specific - version of a resource found at a URL. - Expires: - $ref: '#/components/schemas/Expires' - description: The date and time at which the object is no longer cacheable. - Expiration: - $ref: '#/components/schemas/Expiration' - description: 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 that provide the object expiration information. The value - of the `rule-id` is URL-encoded. - LastModified: - $ref: '#/components/schemas/LastModified' - description: The date and time that the object was last modified. - MissingMeta: - $ref: '#/components/schemas/MissingMeta' - description: 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. - Metadata: - $ref: '#/components/schemas/Metadata' - description: A map of metadata to store with the object in S3. - ObjectLockMode: - $ref: '#/components/schemas/ObjectLockMode' - description: Indicates whether an object stored in Amazon S3 has Object - Lock enabled. For more information about S3 Object Lock, see [Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html). - ObjectLockLegalHoldStatus: - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - description: Indicates whether an object stored in Amazon S3 has an active - legal hold. - ObjectLockRetainUntilDate: - $ref: '#/components/schemas/ObjectLockRetainUntilDate' - description: The date and time when Object Lock is configured to expire. - PartsCount: - $ref: '#/components/schemas/PartsCount' - description: The count of parts this object has. - ReplicationStatus: - $ref: '#/components/schemas/ReplicationStatus' - description: Indicates if request involves bucket that is either a source - or destination in a Replication rule. For more information about S3 Replication, - see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html). - RequestCharged: - $ref: '#/components/schemas/RequestCharged' - Restore: - $ref: '#/components/schemas/Restore' - description: Provides information about object restoration operation and - expiration time of the restored object copy. - ServerSideEncryption: - $ref: '#/components/schemas/ServerSideEncryption' - description: 'The server-side encryption algorithm used when storing requested - object in Amazon S3 or Amazon FSx. - - - When accessing data stored in Amazon FSx file systems using S3 access - points, the only valid server side encryption option is `aws:fsx`.' - SSECustomerAlgorithm: - $ref: '#/components/schemas/SSECustomerAlgorithm' - description: Encryption algorithm used if server-side encryption with a - customer-provided encryption key was specified for object stored in Amazon - S3. - SSEKMSKeyId: - $ref: '#/components/schemas/SSEKMSKeyId' - description: If present, specifies the ID (Key ID, Key ARN, or Key Alias) - of the Amazon Web Services Key Management Service (Amazon Web Services - KMS) symmetric encryption customer managed key that was used for stored - in Amazon S3 object. - SSECustomerKeyMD5: - $ref: '#/components/schemas/SSECustomerKeyMD5' - description: 128-bit MD5 digest of customer-provided encryption key used - in Amazon S3 to encrypt data stored in S3. For more information, see [Protecting - data using server-side encryption with customer-provided encryption keys - (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html). - StorageClass: - $ref: '#/components/schemas/StorageClass' - description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).' - TagCount: - $ref: '#/components/schemas/TagCount' - description: The number of tags, if any, on the object. - VersionId: - $ref: '#/components/schemas/ObjectVersionId' - description: An ID used to reference a specific version of the object. - BucketKeyEnabled: - $ref: '#/components/schemas/BucketKeyEnabled' - description: Indicates whether the object stored in Amazon S3 uses an S3 - bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS). - required: - - RequestRoute - - RequestToken - WriteOffsetBytes: - type: integer - format: int64 - Years: - type: integer - metadatavalue: - type: object - description: Schema definition for metadatavalue (auto-generated placeholder) - x-orphaned: true - x-stackQL-resources: - bucket_abac: - id: aws.s3.bucket_abac - name: bucket_abac - title: Bucket Abac - methods: - get_bucket_abac: - operation: - $ref: '#/paths/~1?abac/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_abac: - operation: - $ref: '#/paths/~1?abac/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - schema_override: - $ref: '#/components/schemas/AbacInputOverride' - transform: - type: golang_template_text_v0.1.0 - body: | - placeholder nothing to see here - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_abac/methods/get_bucket_abac' - insert: [] - update: [] - delete: [] - bucket_accelerate_configurations: - id: aws.s3.bucket_accelerate_configurations - name: bucket_accelerate_configurations - title: Bucket Accelerate Configurations - methods: - get_bucket_accelerate_configuration: - operation: - $ref: '#/paths/~1{Bucket}?accelerate/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_accelerate_configuration: - operation: - $ref: '#/paths/~1{Bucket}?accelerate/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_accelerate_configurations/methods/get_bucket_accelerate_configuration' - insert: [] - update: [] - delete: [] - bucket_acls: - id: aws.s3.bucket_acls - name: bucket_acls - title: Bucket Acls - methods: - get_bucket_acl: - operation: - $ref: '#/paths/~1{Bucket}?acl/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_acl: - operation: - $ref: '#/paths/~1{Bucket}?acl/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_acls/methods/get_bucket_acl' - insert: [] - update: [] - delete: [] - bucket_analytics_configurations: - id: aws.s3.bucket_analytics_configurations - name: bucket_analytics_configurations - title: Bucket Analytics Configurations - methods: - delete_bucket_analytics_configuration: - operation: - $ref: '#/paths/~1{Bucket}?analytics/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_analytics_configuration: - operation: - $ref: '#/paths/~1{Bucket}?analytics&x-id=GetBucketAnalyticsConfiguration/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_bucket_analytics_configurations: - operation: - $ref: '#/paths/~1{Bucket}?analytics&x-id=ListBucketAnalyticsConfigurations/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_analytics_configuration: - operation: - $ref: '#/paths/~1{Bucket}?analytics/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_analytics_configurations/methods/get_bucket_analytics_configuration' - - $ref: '#/components/x-stackQL-resources/bucket_analytics_configurations/methods/list_bucket_analytics_configurations' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_analytics_configurations/methods/delete_bucket_analytics_configuration' - bucket_cors: - id: aws.s3.bucket_cors - name: bucket_cors - title: Bucket Cors - methods: - delete_bucket_cors: - operation: - $ref: '#/paths/~1{Bucket}?cors/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_cors: - operation: - $ref: '#/paths/~1{Bucket}?cors/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_cors: - operation: - $ref: '#/paths/~1{Bucket}?cors/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_cors/methods/get_bucket_cors' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_cors/methods/delete_bucket_cors' - bucket_encryption: - id: aws.s3.bucket_encryption - name: bucket_encryption - title: Bucket Encryption - methods: - delete_bucket_encryption: - operation: - $ref: '#/paths/~1{Bucket}?encryption/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_encryption: - operation: - $ref: '#/paths/~1{Bucket}?encryption/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_encryption: - operation: - $ref: '#/paths/~1{Bucket}?encryption/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_encryption/methods/get_bucket_encryption' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_encryption/methods/delete_bucket_encryption' - bucket_intelligent_tiering_configurations: - id: aws.s3.bucket_intelligent_tiering_configurations - name: bucket_intelligent_tiering_configurations - title: Bucket Intelligent Tiering Configurations - methods: - delete_bucket_intelligent_tiering_configuration: - operation: - $ref: '#/paths/~1{Bucket}?intelligent-tiering/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_intelligent_tiering_configuration: - operation: - $ref: '#/paths/~1{Bucket}?intelligent-tiering&x-id=GetBucketIntelligentTieringConfiguration/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_bucket_intelligent_tiering_configurations: - operation: - $ref: '#/paths/~1{Bucket}?intelligent-tiering&x-id=ListBucketIntelligentTieringConfigurations/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_intelligent_tiering_configuration: - operation: - $ref: '#/paths/~1{Bucket}?intelligent-tiering/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_intelligent_tiering_configurations/methods/get_bucket_intelligent_tiering_configuration' - - $ref: '#/components/x-stackQL-resources/bucket_intelligent_tiering_configurations/methods/list_bucket_intelligent_tiering_configurations' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_intelligent_tiering_configurations/methods/delete_bucket_intelligent_tiering_configuration' - bucket_inventory_configurations: - id: aws.s3.bucket_inventory_configurations - name: bucket_inventory_configurations - title: Bucket Inventory Configurations - methods: - delete_bucket_inventory_configuration: - operation: - $ref: '#/paths/~1{Bucket}?inventory/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_inventory_configuration: - operation: - $ref: '#/paths/~1{Bucket}?inventory&x-id=GetBucketInventoryConfiguration/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_bucket_inventory_configurations: - operation: - $ref: '#/paths/~1{Bucket}?inventory&x-id=ListBucketInventoryConfigurations/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_inventory_configuration: - operation: - $ref: '#/paths/~1{Bucket}?inventory/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_inventory_configurations/methods/get_bucket_inventory_configuration' - - $ref: '#/components/x-stackQL-resources/bucket_inventory_configurations/methods/list_bucket_inventory_configurations' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_inventory_configurations/methods/delete_bucket_inventory_configuration' - bucket_lifecycle_configurations: - id: aws.s3.bucket_lifecycle_configurations - name: bucket_lifecycle_configurations - title: Bucket Lifecycle Configurations - methods: - delete_bucket_lifecycle: - operation: - $ref: '#/paths/~1{Bucket}?lifecycle/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_lifecycle_configuration: - operation: - $ref: '#/paths/~1{Bucket}?lifecycle/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_lifecycle_configuration: - operation: - $ref: '#/paths/~1{Bucket}?lifecycle/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_lifecycle_configurations/methods/get_bucket_lifecycle_configuration' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_lifecycle_configurations/methods/delete_bucket_lifecycle' - bucket_locations: - id: aws.s3.bucket_locations - name: bucket_locations - title: Bucket Locations - methods: - get_bucket_location: - operation: - $ref: '#/paths/~1?location/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_locations/methods/get_bucket_location' - insert: [] - update: [] - delete: [] - bucket_logging: - id: aws.s3.bucket_logging - name: bucket_logging - title: Bucket Logging - methods: - get_bucket_logging: - operation: - $ref: '#/paths/~1{Bucket}?logging/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_logging: - operation: - $ref: '#/paths/~1{Bucket}?logging/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_logging/methods/get_bucket_logging' - insert: [] - update: [] - delete: [] - bucket_metadata_configurations: - id: aws.s3.bucket_metadata_configurations - name: bucket_metadata_configurations - title: Bucket Metadata Configurations - methods: - create_bucket_metadata_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataConfiguration/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - delete_bucket_metadata_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataConfiguration/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_metadata_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataConfiguration/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_configurations/methods/get_bucket_metadata_configuration' - insert: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_configurations/methods/create_bucket_metadata_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_configurations/methods/delete_bucket_metadata_configuration' - bucket_metadata_inventory_table_configurations: - id: aws.s3.bucket_metadata_inventory_table_configurations - name: bucket_metadata_inventory_table_configurations - title: Bucket Metadata Inventory Table Configurations - methods: - update_bucket_metadata_inventory_table_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataInventoryTable/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: [] - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_inventory_table_configurations/methods/update_bucket_metadata_inventory_table_configuration' - delete: [] - bucket_metadata_journal_table_configurations: - id: aws.s3.bucket_metadata_journal_table_configurations - name: bucket_metadata_journal_table_configurations - title: Bucket Metadata Journal Table Configurations - methods: - update_bucket_metadata_journal_table_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataJournalTable/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: [] - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_journal_table_configurations/methods/update_bucket_metadata_journal_table_configuration' - delete: [] - bucket_metadata_table_configurations: - id: aws.s3.bucket_metadata_table_configurations - name: bucket_metadata_table_configurations - title: Bucket Metadata Table Configurations - methods: - create_bucket_metadata_table_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataTable/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - delete_bucket_metadata_table_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataTable/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_metadata_table_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metadataTable/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_table_configurations/methods/get_bucket_metadata_table_configuration' - insert: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_table_configurations/methods/create_bucket_metadata_table_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_metadata_table_configurations/methods/delete_bucket_metadata_table_configuration' - bucket_metrics_configurations: - id: aws.s3.bucket_metrics_configurations - name: bucket_metrics_configurations - title: Bucket Metrics Configurations - methods: - delete_bucket_metrics_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metrics/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_metrics_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metrics&x-id=GetBucketMetricsConfiguration/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_bucket_metrics_configurations: - operation: - $ref: '#/paths/~1{Bucket}?metrics&x-id=ListBucketMetricsConfigurations/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_metrics_configuration: - operation: - $ref: '#/paths/~1{Bucket}?metrics/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_metrics_configurations/methods/get_bucket_metrics_configuration' - - $ref: '#/components/x-stackQL-resources/bucket_metrics_configurations/methods/list_bucket_metrics_configurations' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_metrics_configurations/methods/delete_bucket_metrics_configuration' - bucket_notification_configurations: - id: aws.s3.bucket_notification_configurations - name: bucket_notification_configurations - title: Bucket Notification Configurations - methods: - get_bucket_notification_configuration: - operation: - $ref: '#/paths/~1{Bucket}?notification/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_notification_configuration: - operation: - $ref: '#/paths/~1{Bucket}?notification/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_notification_configurations/methods/get_bucket_notification_configuration' - insert: [] - update: [] - delete: [] - bucket_ownership_controls: - id: aws.s3.bucket_ownership_controls - name: bucket_ownership_controls - title: Bucket Ownership Controls - methods: - delete_bucket_ownership_controls: - operation: - $ref: '#/paths/~1{Bucket}?ownershipControls/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_ownership_controls: - operation: - $ref: '#/paths/~1{Bucket}?ownershipControls/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_ownership_controls: - operation: - $ref: '#/paths/~1{Bucket}?ownershipControls/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_ownership_controls/methods/get_bucket_ownership_controls' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_ownership_controls/methods/delete_bucket_ownership_controls' - bucket_policies: - id: aws.s3.bucket_policies - name: bucket_policies - title: Bucket Policies - methods: - delete_bucket_policy: - operation: - $ref: '#/paths/~1{Bucket}?policy/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_policy: - operation: - $ref: '#/paths/~1{Bucket}?policy/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_policy: - operation: - $ref: '#/paths/~1{Bucket}?policy/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/get_bucket_policy' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_bucket_policy' - bucket_policy_statuses: - id: aws.s3.bucket_policy_statuses - name: bucket_policy_statuses - title: Bucket Policy Statuses - methods: - get_bucket_policy_status: - operation: - $ref: '#/paths/~1{Bucket}?policyStatus/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_policy_statuses/methods/get_bucket_policy_status' - insert: [] - update: [] - delete: [] - bucket_replication: - id: aws.s3.bucket_replication - name: bucket_replication - title: Bucket Replication - methods: - delete_bucket_replication: - operation: - $ref: '#/paths/~1{Bucket}?replication/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_replication: - operation: - $ref: '#/paths/~1{Bucket}?replication/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_replication: - operation: - $ref: '#/paths/~1{Bucket}?replication/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_replication/methods/get_bucket_replication' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_replication/methods/delete_bucket_replication' - bucket_request_payment: - id: aws.s3.bucket_request_payment - name: bucket_request_payment - title: Bucket Request Payment - methods: - get_bucket_request_payment: - operation: - $ref: '#/paths/~1{Bucket}?requestPayment/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_request_payment: - operation: - $ref: '#/paths/~1{Bucket}?requestPayment/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_request_payment/methods/get_bucket_request_payment' - insert: [] - update: [] - delete: [] - bucket_tagging: - id: aws.s3.bucket_tagging - name: bucket_tagging - title: Bucket Tagging - methods: - delete_bucket_tagging: - operation: - $ref: '#/paths/~1{Bucket}?tagging/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_tagging: - operation: - $ref: '#/paths/~1{Bucket}?tagging/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_tagging: - operation: - $ref: '#/paths/~1{Bucket}?tagging/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_tagging/methods/get_bucket_tagging' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_tagging/methods/delete_bucket_tagging' - bucket_versioning: - id: aws.s3.bucket_versioning - name: bucket_versioning - title: Bucket Versioning - methods: - get_bucket_versioning: - operation: - $ref: '#/paths/~1{Bucket}?versioning/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_versioning: - operation: - $ref: '#/paths/~1{Bucket}?versioning/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_versioning/methods/get_bucket_versioning' - insert: [] - update: [] - delete: [] - bucket_websites: - id: aws.s3.bucket_websites - name: bucket_websites - title: Bucket Websites - methods: - delete_bucket_website: - operation: - $ref: '#/paths/~1{Bucket}?website/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_bucket_website: - operation: - $ref: '#/paths/~1{Bucket}?website/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_bucket_website: - operation: - $ref: '#/paths/~1{Bucket}?website/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bucket_websites/methods/get_bucket_website' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/bucket_websites/methods/delete_bucket_website' - buckets: - id: aws.s3.buckets - name: buckets - title: Buckets - methods: - create_bucket: - operation: - $ref: '#/paths/~1{Bucket}/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - delete_bucket: - operation: - $ref: '#/paths/~1{Bucket}/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - head_bucket: - operation: - $ref: '#/paths/~1{Bucket}/head' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_buckets: - operation: - $ref: '#/paths/~1?x-id=ListBuckets&__region={region}/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - objectKey: /*/Buckets/* - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/buckets/methods/list_buckets' - insert: - - $ref: '#/components/x-stackQL-resources/buckets/methods/create_bucket' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_bucket' - directory_buckets: - id: aws.s3.directory_buckets - name: directory_buckets - title: Directory Buckets - methods: - list_directory_buckets: - operation: - $ref: '#/paths/~1?x-id=ListDirectoryBuckets/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - objectKey: $.Buckets - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/directory_buckets/methods/list_directory_buckets' - insert: [] - update: [] - delete: [] - multipart_upload_parts: - id: aws.s3.multipart_upload_parts - name: multipart_upload_parts - title: Multipart Upload Parts - methods: - list_parts: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=ListParts/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - objectKey: $.Parts - pagination: - requestToken: - key: PartNumberMarker - location: query - responseToken: - key: NextPartNumberMarker - location: body - upload_part: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=UploadPart/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - upload_part_copy: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=UploadPartCopy/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/multipart_upload_parts/methods/list_parts' - insert: [] - update: [] - delete: [] - multipart_uploads: - id: aws.s3.multipart_uploads - name: multipart_uploads - title: Multipart Uploads - methods: - abort_multipart_upload: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=AbortMultipartUpload/delete' - response: - mediaType: text/xml - openAPIDocKey: '204' - complete_multipart_upload: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}/post' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - create_multipart_upload: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?uploads/post' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_multipart_uploads: - operation: - $ref: '#/paths/~1{Bucket}?uploads/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/list_multipart_uploads' - insert: - - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/create_multipart_upload' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/abort_multipart_upload' - object_acls: - id: aws.s3.object_acls - name: object_acls - title: Object Acls - methods: - get_object_acl: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?acl/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_object_acl: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?acl/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_acls/methods/get_object_acl' - insert: [] - update: [] - delete: [] - object_attributes: - id: aws.s3.object_attributes - name: object_attributes - title: Object Attributes + description: The name of the bucket. + CreationDate: + $ref: '#/components/schemas/CreationDate' + description: Date the bucket was created. This date can change when making + changes to your bucket, such as editing its bucket policy. + BucketRegion: + $ref: '#/components/schemas/BucketRegion' + description: '`BucketRegion` indicates the Amazon Web Services region where + the bucket is located. If the request contains at least one valid parameter, + it is included in the response.' + BucketArn: + $ref: '#/components/schemas/S3RegionalOrS3ExpressBucketArnString' + description: 'The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely + identify Amazon Web Services resources across all of Amazon Web Services. + + + This parameter is only supported for S3 directory buckets. For more information, + see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).' + description: In terms of implementation, a Bucket is a resource. + BucketAbacStatus: + type: string + enum: + - Enabled + - Disabled + BucketAccelerateStatus: + type: string + enum: + - Enabled + - Suspended + BucketAlreadyExists: + type: object + properties: {} + description: 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. + BucketAlreadyOwnedByYou: + type: object + properties: {} + description: 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). + BucketCannedACL: + type: string + enum: + - private + - public-read + - public-read-write + - authenticated-read + BucketInfo: + type: object + properties: + DataRedundancy: + $ref: '#/components/schemas/DataRedundancy' + description: The number of Zone (Availability Zone or Local Zone) that's + used for redundancy for the bucket. + Type: + $ref: '#/components/schemas/BucketType' + description: The type of bucket. + description: 'Specifies the information about the bucket that will be created. + For more information about directory buckets, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) + in the _Amazon S3 User Guide_. + + + This functionality is only supported by directory buckets.' + BucketKeyEnabled: + type: boolean + BucketLifecycleConfiguration: + type: object + properties: + Rules: + $ref: '#/components/schemas/LifecycleRules' + description: A lifecycle rule for individual objects in an Amazon S3 bucket. + required: + - Rules + description: Specifies the lifecycle configuration for objects in an Amazon + S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) + in the _Amazon S3 User Guide_. + BucketLocationConstraint: + type: string + enum: + - af-south-1 + - ap-east-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-south-1 + - ap-south-2 + - ap-southeast-1 + - ap-southeast-2 + - ap-southeast-3 + - ap-southeast-4 + - ap-southeast-5 + - ca-central-1 + - cn-north-1 + - cn-northwest-1 + - EU + - eu-central-1 + - eu-central-2 + - eu-north-1 + - eu-south-1 + - eu-south-2 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - il-central-1 + - me-central-1 + - me-south-1 + - sa-east-1 + - us-east-2 + - us-gov-east-1 + - us-gov-west-1 + - us-west-1 + - us-west-2 + BucketLocationName: + type: string + BucketLoggingStatus: + type: object + properties: + LoggingEnabled: + $ref: '#/components/schemas/LoggingEnabled' + description: Container for logging status information. + BucketLogsPermission: + type: string + enum: + - FULL_CONTROL + - READ + - WRITE + BucketName: + type: string + BucketRegion: + type: string + BucketType: + type: string + enum: + - Directory + BucketVersioningStatus: + type: string + enum: + - Enabled + - Suspended + Buckets: + type: array + items: + allOf: + - $ref: '#/components/schemas/Bucket' + - xml: + name: Bucket + + BypassGovernanceRetention: + type: boolean + BytesProcessed: + type: integer + format: int64 + BytesReturned: + type: integer + format: int64 + BytesScanned: + type: integer + format: int64 + CORSConfiguration: + type: object + properties: + CORSRules: + $ref: '#/components/schemas/CORSRules' + description: A set of origins and methods (cross-origin access that you + want to allow). You can add up to 100 rules to the configuration. + required: + - CORSRules + description: Describes the cross-origin access configuration for objects in + an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource + Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the + _Amazon S3 User Guide_. + CORSRule: + type: object + properties: + ID: + $ref: '#/components/schemas/ID' + description: Unique identifier for the rule. The value cannot be longer + than 255 characters. + AllowedHeaders: + $ref: '#/components/schemas/AllowedHeaders' + description: Headers that are specified in the `Access-Control-Request-Headers` + header. These headers are allowed in a preflight OPTIONS request. In response + to any preflight OPTIONS request, Amazon S3 returns any requested headers + that are allowed. + AllowedMethods: + $ref: '#/components/schemas/AllowedMethods' + description: An HTTP method that you allow the origin to execute. Valid + values are `GET`, `PUT`, `HEAD`, `POST`, and `DELETE`. + AllowedOrigins: + $ref: '#/components/schemas/AllowedOrigins' + description: One or more origins you want customers to be able to access + the bucket from. + ExposeHeaders: + $ref: '#/components/schemas/ExposeHeaders' + description: One or more headers in the response that you want customers + to be able to access from their applications (for example, from a JavaScript + `XMLHttpRequest` object). + MaxAgeSeconds: + $ref: '#/components/schemas/MaxAgeSeconds' + description: The time in seconds that your browser is to cache the preflight + response for the specified resource. + required: + - AllowedMethods + - AllowedOrigins + description: Specifies a cross-origin access rule for an Amazon S3 bucket. + CORSRules: + type: array + items: + $ref: '#/components/schemas/CORSRule' + CSVInput: + type: object + properties: + FileHeaderInfo: + $ref: '#/components/schemas/FileHeaderInfo' + description: "Describes the first line of input. Valid values are:\n\n \ + \ * `NONE`: First line is not a header.\n\n * `IGNORE`: First line is\ + \ a header, but you can't use the header values to indicate the column\ + \ in an expression. You can use column position (such as _1, _2, …) to\ + \ indicate the column (`SELECT s._1 FROM OBJECT s`).\n\n * `Use`: First\ + \ line is a header, and you can use the header value to identify a column\ + \ in an expression (`SELECT \"name\" FROM OBJECT`)." + Comments: + $ref: '#/components/schemas/Comments' + description: 'A single character used to indicate that a row should be ignored + when the character is present at the start of that row. You can specify + any character to indicate a comment line. The default character is `#`. + + + Default: `#`' + QuoteEscapeCharacter: + $ref: '#/components/schemas/QuoteEscapeCharacter' + description: A single character used for escaping the quotation mark character + inside an already escaped value. For example, the value `""" a , b """` + is parsed as `" a , b "`. + RecordDelimiter: + $ref: '#/components/schemas/RecordDelimiter' + description: A single character used to separate individual records in the + input. Instead of the default value, you can specify an arbitrary delimiter. + FieldDelimiter: + $ref: '#/components/schemas/FieldDelimiter' + description: A single character used to separate individual fields in a + record. You can specify an arbitrary delimiter. + QuoteCharacter: + $ref: '#/components/schemas/QuoteCharacter' + description: 'A single character used for escaping when the field delimiter + is part of the value. For example, if the value is `a, b`, Amazon S3 wraps + this field value in quotation marks, as follows: `" a , b "`. + + + Type: String + + + Default: `"` + + + Ancestors: `CSV`' + AllowQuotedRecordDelimiter: + $ref: '#/components/schemas/AllowQuotedRecordDelimiter' + description: Specifies that CSV field values may contain quoted record delimiters + and such records should be allowed. Default value is FALSE. Setting this + value to TRUE may lower performance. + description: Describes how an uncompressed comma-separated values (CSV)-formatted + input object is formatted. + CSVOutput: + type: object + properties: + QuoteFields: + $ref: '#/components/schemas/QuoteFields' + description: "Indicates whether to use quotation marks around output fields.\n\ + \n * `ALWAYS`: Always use quotation marks for output fields.\n\n * `ASNEEDED`:\ + \ Use quotation marks for output fields when needed." + QuoteEscapeCharacter: + $ref: '#/components/schemas/QuoteEscapeCharacter' + description: The single character used for escaping the quote character + inside an already escaped value. + RecordDelimiter: + $ref: '#/components/schemas/RecordDelimiter' + description: A single character used to separate individual records in the + output. Instead of the default value, you can specify an arbitrary delimiter. + FieldDelimiter: + $ref: '#/components/schemas/FieldDelimiter' + description: The value used to separate individual fields in a record. You + can specify an arbitrary delimiter. + QuoteCharacter: + $ref: '#/components/schemas/QuoteCharacter' + description: 'A single character used for escaping when the field delimiter + is part of the value. For example, if the value is `a, b`, Amazon S3 wraps + this field value in quotation marks, as follows: `" a , b "`.' + description: Describes how uncompressed comma-separated values (CSV)-formatted + results are formatted. + CacheControl: + type: string + Checksum: + type: object + properties: + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. + This checksum is present if the object was uploaded with the `CRC64NVME` + checksum algorithm, or if the object was uploaded without a checksum (and + Amazon S3 added the default checksum, `CRC64NVME`, to the uploaded object). + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type that is used to calculate the object’s checksum + value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + description: Contains all the possible checksum or digest values for an object. + ChecksumAlgorithm: + type: string + enum: + - CRC32 + - CRC32C + - SHA1 + - SHA256 + - CRC64NVME + ChecksumAlgorithmList: + type: array + items: + $ref: '#/components/schemas/ChecksumAlgorithm' + ChecksumCRC32: + type: string + ChecksumCRC32C: + type: string + ChecksumCRC64NVME: + type: string + ChecksumMode: + type: string + enum: + - ENABLED + ChecksumSHA1: + type: string + ChecksumSHA256: + type: string + ChecksumType: + type: string + enum: + - COMPOSITE + - FULL_OBJECT + ClientToken: + type: string + Code: + type: string + Comments: + type: string + CommonPrefix: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: Container for the specified common prefix. + description: Container for 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/. + CommonPrefixList: + type: array + items: + $ref: '#/components/schemas/CommonPrefix' + CompleteMultipartUploadOutput: + type: object + properties: + Location: + $ref: '#/components/schemas/Location' + description: The URI that identifies the newly created object. + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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: + $ref: '#/components/schemas/ObjectKey' + description: The object key of the newly created object. + Expiration: + $ref: '#/components/schemas/Expiration' + description: '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.' + ETag: + $ref: '#/components/schemas/ETag' + description: Entity tag that identifies the newly created object's data. + Objects with different object data will have different entity tags. The + entity tag is an opaque string. The entity tag may or may not be an MD5 + digest of the object data. If the entity tag is not an MD5 digest of the + object data, it will contain one or more nonhexadecimal characters and/or + will consist of less than 32 or more than 32 hexadecimal digits. For more + information about how the entity tag is calculated, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the + object. The `CRC64NVME` checksum is always a full object checksum. For + more information, see [Checking object integrity in the Amazon S3 User + Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type, which determines how part-level checksums + are combined to create an object-level checksum for multipart objects. + You can use this header as a data integrity check to verify that the checksum + type that is received is the same checksum type that was specified during + the `CreateMultipartUpload` request. For more information, see [Checking + object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when storing this + object in Amazon S3. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID of the newly created object, in case the bucket + has versioning turned on. + + + This functionality is not supported for directory buckets.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the multipart upload uses an S3 Bucket Key + for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + CompleteMultipartUploadRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload was initiated. + MultipartUpload: + $ref: '#/components/schemas/CompletedMultipartUpload' + description: The container for the multipart upload request information. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: ID for the initiated multipart upload. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32` checksum of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the + object. The `CRC64NVME` checksum is always a full object checksum. For + more information, see [Checking object integrity in the Amazon S3 User + Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 160-bit `SHA1` digest of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 256-bit `SHA256` digest of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: This header specifies the checksum type of the object, which + determines how part-level checksums are combined to create an object-level + checksum for multipart objects. You can use this header as a data integrity + check to verify that the checksum type that is received is the same checksum + that was specified. If the checksum type doesn’t match the checksum type + that was specified for the object during the `CreateMultipartUpload` request, + it’ll result in a `BadDigest` error. For more information, see Checking + object integrity in the Amazon S3 User Guide. + MpuObjectSize: + $ref: '#/components/schemas/MpuObjectSize' + description: The expected total object size of the multipart upload request. + If there’s a mismatch between the specified object size value and the + actual object size value, it results in an `HTTP 400 InvalidRequest` error. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + IfMatch: + $ref: '#/components/schemas/IfMatch' + description: 'Uploads the object only if the ETag (entity tag) value provided + during the WRITE operation matches the ETag of the object in S3. If the + ETag values do not match, the operation returns a `412 Precondition Failed` + error. + + + If a conflicting operation occurs during the upload S3 returns a `409 + ConditionalRequestConflict` response. On a 409 failure you should fetch + the object''s ETag, re-initiate the multipart upload with `CreateMultipartUpload`, + and re-upload each part. + + + Expects the ETag value as a string. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), + or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) + in the _Amazon S3 User Guide_.' + IfNoneMatch: + $ref: '#/components/schemas/IfNoneMatch' + description: 'Uploads the object only if the object key name does not already + exist in the bucket specified. Otherwise, Amazon S3 returns a `412 Precondition + Failed` error. + + + If a conflicting operation occurs during the upload S3 returns a `409 + ConditionalRequestConflict` response. On a 409 failure you should re-initiate + the multipart upload with `CreateMultipartUpload` and re-upload each part. + + + Expects the ''*'' (asterisk) character. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), + or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) + in the _Amazon S3 User Guide_.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + required: + - Bucket + - Key + - UploadId + CompletedMultipartUpload: + type: object + properties: + Parts: + $ref: '#/components/schemas/CompletedPartList' + description: 'Array of CompletedPart data types. + + + If you do not supply a valid `Part` with your request, the service sends + back an HTTP 400 response.' + description: The container for the completed multipart upload details. + CompletedPart: + type: object + properties: + ETag: + $ref: '#/components/schemas/ETag' + description: Entity tag returned when the part was uploaded. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32` checksum of the part. This + checksum is present if the multipart upload request was created with the + `CRC32` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the part. This + checksum is present if the multipart upload request was created with the + `CRC32C` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. + This checksum is present if the multipart upload request was created with + the `CRC64NVME` checksum algorithm to the uploaded object). For more information, + see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` checksum of the part. This + checksum is present if the multipart upload request was created with the + `SHA1` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` checksum of the part. + This checksum is present if the multipart upload request was created with + the `SHA256` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: "Part number that identifies the part. This is a positive integer\ + \ between 1 and 10,000.\n\n * **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.\n\n * **Directory\ + \ buckets** \\- In `CompleteMultipartUpload`, the `PartNumber` must start\ + \ at 1 and the part numbers must be consecutive." + description: Details of the parts that were uploaded. + CompletedPartList: + type: array + items: + $ref: '#/components/schemas/CompletedPart' + CompressionType: + type: string + enum: + - NONE + - GZIP + - BZIP2 + Condition: + type: object + properties: + HttpErrorCodeReturnedEquals: + $ref: '#/components/schemas/HttpErrorCodeReturnedEquals' + description: The HTTP error code when the redirect is applied. In the event + of an error, if the error code equals this value, then the specified redirect + is applied. Required when parent element `Condition` is specified and + sibling `KeyPrefixEquals` is not specified. If both are specified, then + both must be true for the redirect to be applied. + KeyPrefixEquals: + $ref: '#/components/schemas/KeyPrefixEquals' + description: 'The object key name prefix when the redirect is applied. For + example, to redirect requests for `ExamplePage.html`, the key prefix will + be `ExamplePage.html`. To redirect request for all pages with the prefix + `docs/`, the key prefix will be `/docs`, which identifies all objects + in the `docs/` folder. Required when the parent element `Condition` is + specified and sibling `HttpErrorCodeReturnedEquals` is not specified. + If both conditions are specified, both must be true for the redirect to + be applied. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + description: A container for describing a condition that must be met for the + specified redirect to apply. For example, 1. If request is for pages in the + `/docs` folder, redirect to the `/documents` folder. 2. If request results + in HTTP error 4xx, redirect request to another host where you might process + the error. + ConfirmRemoveSelfBucketAccess: + type: boolean + ContentDisposition: + type: string + ContentEncoding: + type: string + ContentLanguage: + type: string + ContentLength: + type: integer + format: int64 + ContentMD5: + type: string + ContentRange: + type: string + ContentType: + type: string + ContinuationEvent: + type: object + properties: {} + description: '' + CopyObjectOutput: + type: object + properties: + CopyObjectResult: + $ref: '#/components/schemas/CopyObjectResult' + description: Container for all response elements. + Expiration: + $ref: '#/components/schemas/Expiration' + description: 'If the object expiration is configured, the response includes + this header. + + + Object expiration information is not returned in directory buckets and + this header returns the value "`NotImplemented`" in all responses for + directory buckets.' + CopySourceVersionId: + $ref: '#/components/schemas/CopySourceVersionId' + description: 'Version ID of the source object that was copied. + + + This functionality is not supported when the source object is in a directory + bucket.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID of the newly created copy. + + + This functionality is not supported for directory buckets.' + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: 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. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the copied object uses an S3 Bucket Key for + server-side encryption with Key Management Service (KMS) keys (SSE-KMS). + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + CopyObjectRequest: + type: object + properties: + ACL: + $ref: '#/components/schemas/ObjectCannedACL' + description: "The canned access control list (ACL) to apply to the object.\n\ + \nWhen 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).\n\ + \nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ + \ in the _Amazon S3 User Guide_.\n\n * 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.\n\ + \n * This functionality is not supported for directory buckets.\n\n \ + \ * This functionality is not supported for Amazon S3 on Outposts." + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + Copying objects across different Amazon Web Services Regions isn''t supported + when the source or destination bucket is in Amazon Web Services Local + Zones. The source and destination buckets must have the same parent Amazon + Web Services Region. Otherwise, you get an HTTP `400 Bad Request` error + with the error code `InvalidRequest`. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with S3 on Outposts, you + must use the Outpost bucket access point ARN or the access point alias + for the destination bucket. You can only copy objects within the same + Outpost bucket. It''s not supported to copy objects across different Amazon + Web Services Outposts, between buckets on the same Outposts, or between + Outposts buckets and any other bucket types. For more information about + S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _S3 on Outposts guide_. When you use this action with S3 on Outposts + through the REST API, you must direct requests to the S3 on Outposts hostname, + in the format ` _AccessPointName_ -_AccountId_._outpostID_.s3-outposts._Region_.amazonaws.com`. + The hostname isn''t required when you use the Amazon Web Services CLI + or SDKs.' + CacheControl: + $ref: '#/components/schemas/CacheControl' + description: Specifies the caching behavior along the request/reply chain. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm that you want Amazon S3 to use to + create the checksum for the object. For more information, see [Checking + object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + 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.' + ContentDisposition: + $ref: '#/components/schemas/ContentDisposition' + description: 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. + ContentEncoding: + $ref: '#/components/schemas/ContentEncoding' + description: '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.' + ContentLanguage: + $ref: '#/components/schemas/ContentLanguage' + description: The language the content is in. + ContentType: + $ref: '#/components/schemas/ContentType' + description: A standard MIME type that describes the format of the object + data. + CopySource: + $ref: '#/components/schemas/CopySource' + description: "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.\n\ + \nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):\n\ + \n * 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.\n\n * 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:::accesspoint//object/`.\ + \ 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.\n\n * Amazon S3 supports copy operations\ + \ using Access points only when the source and destination buckets are\ + \ in the same Amazon Web Services Region.\n\n * Access points are not\ + \ supported by directory buckets.\n\nAlternatively, for objects accessed\ + \ through Amazon S3 on Outposts, specify the ARN of the object as accessed\ + \ in the format `arn:aws:s3-outposts:::outpost//object/`. 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.\n\nIf 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=`\ + \ 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.\n\nIf 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.\n\nIf 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.\n\ + \n**Directory buckets** \\- S3 Versioning isn't enabled and supported\ + \ for directory buckets." + CopySourceIfMatch: + $ref: '#/components/schemas/CopySourceIfMatch' + description: "Copies the object if its entity tag (ETag) matches the specified\ + \ tag.\n\nIf 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:\n\n * `x-amz-copy-source-if-match`\ + \ condition evaluates to true\n\n * `x-amz-copy-source-if-unmodified-since`\ + \ condition evaluates to false" + CopySourceIfModifiedSince: + $ref: '#/components/schemas/CopySourceIfModifiedSince' + description: "Copies the object if it has been modified since the specified\ + \ time.\n\nIf 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:\n\n * `x-amz-copy-source-if-none-match`\ + \ condition evaluates to false\n\n * `x-amz-copy-source-if-modified-since`\ + \ condition evaluates to true" + CopySourceIfNoneMatch: + $ref: '#/components/schemas/CopySourceIfNoneMatch' + description: "Copies the object if its entity tag (ETag) is different than\ + \ the specified ETag.\n\nIf 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:\n\n * `x-amz-copy-source-if-none-match` condition\ + \ evaluates to false\n\n * `x-amz-copy-source-if-modified-since` condition\ + \ evaluates to true" + CopySourceIfUnmodifiedSince: + $ref: '#/components/schemas/CopySourceIfUnmodifiedSince' + description: "Copies the object if it hasn't been modified since the specified\ + \ time.\n\nIf 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:\n\n * `x-amz-copy-source-if-match`\ + \ condition evaluates to true\n\n * `x-amz-copy-source-if-unmodified-since`\ + \ condition evaluates to false" + Expires: + $ref: '#/components/schemas/Expires' + description: The date and time at which the object is no longer cacheable. + GrantFullControl: + $ref: '#/components/schemas/GrantFullControl' + description: "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions\ + \ on the object.\n\n * This functionality is not supported for directory\ + \ buckets.\n\n * This functionality is not supported for Amazon S3 on\ + \ Outposts." + GrantRead: + $ref: '#/components/schemas/GrantRead' + description: "Allows grantee to read the object data and its metadata.\n\ + \n * This functionality is not supported for directory buckets.\n\n \ + \ * This functionality is not supported for Amazon S3 on Outposts." + GrantReadACP: + $ref: '#/components/schemas/GrantReadACP' + description: "Allows grantee to read the object ACL.\n\n * This functionality\ + \ is not supported for directory buckets.\n\n * This functionality is\ + \ not supported for Amazon S3 on Outposts." + GrantWriteACP: + $ref: '#/components/schemas/GrantWriteACP' + description: "Allows grantee to write the ACL for the applicable object.\n\ + \n * This functionality is not supported for directory buckets.\n\n \ + \ * This functionality is not supported for Amazon S3 on Outposts." + IfMatch: + $ref: '#/components/schemas/IfMatch' + description: 'Copies the object if the entity tag (ETag) of the destination + object matches the specified tag. If the ETag values do not match, the + operation returns a `412 Precondition Failed` error. If a concurrent operation + occurs during the upload S3 returns a `409 ConditionalRequestConflict` + response. On a 409 failure you should fetch the object''s ETag and retry + the upload. + + + Expects the ETag value as a string. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).' + IfNoneMatch: + $ref: '#/components/schemas/IfNoneMatch' + description: 'Copies the object only if the object key name at the destination + does not already exist in the bucket specified. Otherwise, Amazon S3 returns + a `412 Precondition Failed` error. If a concurrent operation occurs during + the upload S3 returns a `409 ConditionalRequestConflict` response. On + a 409 failure you should retry the upload. + + + Expects the ''*'' (asterisk) character. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key of the destination object. + Metadata: + $ref: '#/components/schemas/Metadata' + description: A map of metadata to store with the object in S3. + MetadataDirective: + $ref: '#/components/schemas/MetadataDirective' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) + 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.' + TaggingDirective: + $ref: '#/components/schemas/TaggingDirective' + description: "Specifies whether the object tag-set is copied from the source\ + \ object or replaced with the tag-set that's provided in the request.\n\ + \nThe default value is `COPY`.\n\n**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:\n\n * When you attempt\ + \ to `COPY` the tag-set from an S3 source object that has non-empty tags.\n\ + \n * When you attempt to `REPLACE` the tag-set of a source object and\ + \ set a non-empty value to `x-amz-tagging`.\n\n * 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`.\n\nBecause only the empty tag-set is supported for directory\ + \ buckets in a `CopyObject` operation, the following situations are allowed:\n\ + \n * 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.\n\n * 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.\n\n * 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.\n\n * 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." + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: "The server-side encryption algorithm used when storing this\ + \ object in Amazon S3. Unrecognized or unsupported values won’t write\ + \ a destination object and will receive a `400 Bad Request` response.\n\ + \nAmazon 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 different default encryption configuration,\ + \ Amazon S3 uses the corresponding encryption key to encrypt the target\ + \ object copy.\n\nWith 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)\ + \ in the _Amazon S3 User Guide_.\n\n**General purpose buckets**\n\n *\ + \ For general purpose buckets, there are the following supported options\ + \ for server-side encryption: server-side encryption with Key Management\ + \ Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with\ + \ Amazon Web Services KMS keys (DSSE-KMS), and 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.\n\ + \n * 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. \n\n**Directory buckets**\n\ + \n * For directory buckets, there are only two supported options for\ + \ server-side encryption: server-side encryption with Amazon S3 managed\ + \ keys (SSE-S3) (`AES256`) and server-side encryption with KMS keys (SSE-KMS)\ + \ (`aws:kms`). We recommend that the bucket's default encryption uses\ + \ the desired encryption configuration and you don't override the bucket\ + \ default encryption in your `CreateSession` requests or `PUT` object\ + \ requests. Then, new objects are automatically encrypted with the desired\ + \ encryption settings. For more information, see [Protecting data with\ + \ server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ + \ in the _Amazon S3 User Guide_. For more information about the encryption\ + \ overriding behaviors in directory buckets, see [Specifying server-side\ + \ encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\n\ + \n * To encrypt new object copies to a directory bucket with SSE-KMS,\ + \ we recommend you specify SSE-KMS as the directory bucket's default encryption\ + \ configuration with a KMS key (specifically, a [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)).\ + \ The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\ + \ (`aws/s3`) isn't supported. Your SSE-KMS configuration can only support\ + \ 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ + \ per directory bucket for the lifetime of the bucket. After you specify\ + \ a customer managed key for SSE-KMS, you can't override the customer\ + \ managed key for the bucket's SSE-KMS configuration. Then, when you perform\ + \ a `CopyObject` operation and want to specify server-side encryption\ + \ settings for new object copies with SSE-KMS in the encryption-related\ + \ request headers, you must ensure the encryption key is the same customer\ + \ managed key that you specified for the directory bucket's default encryption\ + \ configuration. \n\n * **S3 access points for Amazon FSx** \\- When\ + \ accessing data stored in Amazon FSx file systems using S3 access points,\ + \ the only valid server side encryption option is `aws:fsx`. All Amazon\ + \ FSx file systems have encryption configured by default and are encrypted\ + \ at rest. Data is automatically encrypted before being written to the\ + \ file system, and automatically decrypted as it is read. These processes\ + \ are handled transparently by Amazon FSx." + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: "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.\n\n * **Directory buckets** \\- Directory buckets only support\ + \ `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability\ + \ Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class)\ + \ in Dedicated Local Zones. Unsupported storage class values won't write\ + \ a destination object and will respond with the HTTP status code `400\ + \ Bad Request`.\n\n * **Amazon S3 on Outposts** \\- S3 on Outposts only\ + \ uses the `OUTPOSTS` Storage Class.\n\nYou 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)\ + \ in the _Amazon S3 User Guide_.\n\nBefore 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:\n\n * The storage class of the source\ + \ object is `GLACIER` or `DEEP_ARCHIVE`.\n\n * The storage class of the\ + \ source object is `INTELLIGENT_TIERING` and it's [S3 Intelligent-Tiering\ + \ access tier](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition)\ + \ is `Archive Access` or `Deep Archive Access`.\n\nFor more information,\ + \ see [RestoreObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html)\ + \ and [Copying Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html)\ + \ in the _Amazon S3 User Guide_." + WebsiteRedirectLocation: + $ref: '#/components/schemas/WebsiteRedirectLocation' + description: '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.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: 'Specifies the KMS key 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) + in the _Amazon S3 User Guide_. + + + **Directory buckets** \- To encrypt data using SSE-KMS, it''s recommended + to specify the `x-amz-server-side-encryption` header to `aws:kms`. Then, + the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses + the bucket''s default KMS customer managed key ID. If you want to explicitly + set the ` x-amz-server-side-encryption-aws-kms-key-id` header, it must + match the bucket''s default customer managed key (using key ID or ARN, + not alias). Your SSE-KMS configuration can only support 1 [customer managed + key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) + per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + (`aws/s3`) isn''t supported. Incorrect key specification results in an + HTTP `400 Bad Request` error.' + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: 'Specifies the Amazon Web Services KMS Encryption Context as + an additional encryption context to use for the destination object encryption. + The value of this header is a base64-encoded UTF-8 string holding JSON + with the encryption context key-value pairs. + + + **General purpose buckets** \- This value must be explicitly added to + specify encryption context for `CopyObject` requests if you want an additional + encryption context for your destination object. The additional encryption + context of the source object won''t be copied to the destination object. + For more information, see [Encryption context](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context) + in the _Amazon S3 User Guide_. + + + **Directory buckets** \- You can optionally provide an explicit encryption + context value. The value must match the default encryption context - the + bucket Amazon Resource Name (ARN). An additional encryption context value + is not supported.' + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) + in the _Amazon S3 User Guide_. + + + **Directory buckets** \- S3 Bucket Keys aren''t supported, when you copy + SSE-KMS encrypted objects from general purpose buckets to directory buckets, + from directory buckets to general purpose buckets, or between directory + buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html). + In this case, Amazon S3 makes a call to KMS every time a copy request + is made for a KMS-encrypted object.' + CopySourceSSECustomerAlgorithm: + $ref: '#/components/schemas/CopySourceSSECustomerAlgorithm' + description: '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.' + CopySourceSSECustomerKey: + $ref: '#/components/schemas/CopySourceSSECustomerKey' + description: '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.' + CopySourceSSECustomerKeyMD5: + $ref: '#/components/schemas/CopySourceSSECustomerKeyMD5' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + Tagging: + $ref: '#/components/schemas/TaggingHeader' + description: "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.\n\ + \nThe default value is the empty value.\n\n**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:\n\ + \n * When you attempt to `COPY` the tag-set from an S3 source object\ + \ that has non-empty tags.\n\n * When you attempt to `REPLACE` the tag-set\ + \ of a source object and set a non-empty value to `x-amz-tagging`.\n\n\ + \ * 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`.\n\nBecause only the empty tag-set is supported for directory\ + \ buckets in a `CopyObject` operation, the following situations are allowed:\n\ + \n * 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.\n\n * 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.\n\n * 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.\n\n * 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." + ObjectLockMode: + $ref: '#/components/schemas/ObjectLockMode' + description: 'The Object Lock mode that you want to apply to the object + copy. + + + This functionality is not supported for directory buckets.' + ObjectLockRetainUntilDate: + $ref: '#/components/schemas/ObjectLockRetainUntilDate' + description: 'The date and time when you want the Object Lock of the object + copy to expire. + + + This functionality is not supported for directory buckets.' + ObjectLockLegalHoldStatus: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: 'Specifies whether you want to apply a legal hold to the object + copy. + + + This functionality is not supported for directory buckets.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ExpectedSourceBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - CopySource + - Key + CopyObjectResult: + type: object + properties: + ETag: + $ref: '#/components/schemas/ETag' + description: Returns the ETag of the new object. The ETag reflects only + changes to the contents of an object, not its metadata. + LastModified: + $ref: '#/components/schemas/LastModified' + description: Creation date of the object. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type that is used to calculate the object’s checksum + value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32` checksum of the object. + This checksum is only present if the object was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. + This checksum is present if the object being copied was uploaded with + the `CRC64NVME` checksum algorithm, or if the object was uploaded without + a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to + the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + description: Container for all response elements. + CopyPartResult: + type: object + properties: + ETag: + $ref: '#/components/schemas/ETag' + description: Entity tag of the object. + LastModified: + $ref: '#/components/schemas/LastModified' + description: Date and time at which the object was uploaded. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32` checksum of the part. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the part. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. + This checksum is present if the multipart upload request was created with + the `CRC64NVME` checksum algorithm to the uploaded object). For more information, + see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 160-bit `SHA1` checksum of the part. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 256-bit `SHA256` checksum of the + part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + description: Container for all response elements. + CopySource: + type: string + pattern: ^\/?.+\/.+$ + CopySourceIfMatch: + type: string + CopySourceIfModifiedSince: + type: string + format: date-time + CopySourceIfNoneMatch: + type: string + CopySourceIfUnmodifiedSince: + type: string + format: date-time + CopySourceRange: + type: string + CopySourceSSECustomerAlgorithm: + type: string + CopySourceSSECustomerKey: + type: string + CopySourceSSECustomerKeyMD5: + type: string + CopySourceVersionId: + type: string + CreateBucketConfiguration: + type: object + properties: + LocationConstraint: + $ref: '#/components/schemas/BucketLocationConstraint' + description: '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. + + + If you don''t specify a Region, the bucket is created in the US East (N. + Virginia) Region (us-east-1) by default. Configurations using the value + `EU` will create a bucket in `eu-west-1`. + + + For a list of the valid values for all of the Amazon Web Services Regions, + see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). + + + This functionality is not supported for directory buckets.' + Location: + $ref: '#/components/schemas/LocationInfo' + description: 'Specifies the location where the bucket will be created. + + + **Directory buckets** \- The location type is Availability Zone or Local + Zone. To use the Local Zone location type, your account must be enabled + for Local Zones. Otherwise, you get an HTTP `403 Forbidden` error with + the error code `AccessDenied`. To learn more, see [Enable accounts for + Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/opt-in-directory-bucket-lz.html) + in the _Amazon S3 User Guide_. + + + This functionality is only supported by directory buckets.' + Bucket: + $ref: '#/components/schemas/BucketInfo' + description: 'Specifies the information about the bucket that will be created. + + + This functionality is only supported by directory buckets.' + Tags: + $ref: '#/components/schemas/TagSet' + description: 'An array of tags that you can apply to the bucket that you''re + creating. Tags are key-value pairs of metadata used to categorize and + organize your buckets, track costs, and control access. + + + You must have the `s3:TagResource` permission to create a general purpose + bucket with tags or the `s3express:TagResource` permission to create a + directory bucket with tags. + + + When creating buckets with tags, note that tag-based conditions using + `aws:ResourceTag` and `s3:BucketTag` condition keys are applicable only + after ABAC is enabled on the bucket. To learn more, see [Enabling ABAC + in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html).' + description: The configuration information for the bucket. + CreateBucketMetadataConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that you want to create the metadata + configuration for. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: The `Content-MD5` header for the metadata configuration. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The checksum algorithm to use with your metadata configuration. + MetadataConfiguration: + $ref: '#/components/schemas/MetadataConfiguration' + description: The contents of your metadata configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected owner of the general purpose bucket that corresponds + to your metadata configuration. + required: + - Bucket + - MetadataConfiguration + CreateBucketMetadataTableConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that you want to create the metadata + table configuration for. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: The `Content-MD5` header for the metadata table configuration. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The checksum algorithm to use with your metadata table configuration. + MetadataTableConfiguration: + $ref: '#/components/schemas/MetadataTableConfiguration' + description: The contents of your metadata table configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected owner of the general purpose bucket that corresponds + to your metadata table configuration. + required: + - Bucket + - MetadataTableConfiguration + CreateBucketOutput: + type: object + properties: + Location: + $ref: '#/components/schemas/Location' + description: A forward slash followed by the name of the bucket. + BucketArn: + $ref: '#/components/schemas/S3RegionalOrS3ExpressBucketArnString' + description: 'The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely + identify Amazon Web Services resources across all of Amazon Web Services. + + + This parameter is only supported for S3 directory buckets. For more information, + see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).' + CreateBucketRequest: + type: object + properties: + ACL: + $ref: '#/components/schemas/BucketCannedACL' + description: 'The canned ACL to apply to the bucket. + + + This functionality is not supported for directory buckets.' + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The name of the bucket to create. + + + **General purpose buckets** \- For information about bucket naming restrictions, + see [Bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) + 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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + CreateBucketConfiguration: + $ref: '#/components/schemas/CreateBucketConfiguration' + description: The configuration information for the bucket. + GrantFullControl: + $ref: '#/components/schemas/GrantFullControl' + description: 'Allows grantee the read, write, read ACP, and write ACP permissions + on the bucket. + + + This functionality is not supported for directory buckets.' + GrantRead: + $ref: '#/components/schemas/GrantRead' + description: 'Allows grantee to list the objects in the bucket. + + + This functionality is not supported for directory buckets.' + GrantReadACP: + $ref: '#/components/schemas/GrantReadACP' + description: 'Allows grantee to read the bucket ACL. + + + This functionality is not supported for directory buckets.' + GrantWrite: + $ref: '#/components/schemas/GrantWrite' + description: '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.' + GrantWriteACP: + $ref: '#/components/schemas/GrantWriteACP' + description: 'Allows grantee to write the ACL for the applicable bucket. + + + This functionality is not supported for directory buckets.' + ObjectLockEnabledForBucket: + $ref: '#/components/schemas/ObjectLockEnabledForBucket' + description: 'Specifies whether you want S3 Object Lock to be enabled for + the new bucket. + + + This functionality is not supported for directory buckets.' + ObjectOwnership: + $ref: '#/components/schemas/ObjectOwnership' + required: + - Bucket + CreateMultipartUploadOutput: + type: object + properties: + AbortDate: + $ref: '#/components/schemas/AbortDate' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + 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.' + AbortRuleId: + $ref: '#/components/schemas/AbortRuleId' + description: '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.' + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload was initiated. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: ID for the initiated multipart upload. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: If present, indicates the Amazon Web Services KMS Encryption + Context to use for object encryption. The value of this header is a Base64 + encoded string of a UTF-8 encoded JSON, which contains the encryption + context as key-value pairs. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the multipart upload uses an S3 Bucket Key + for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The algorithm that was used to create a checksum of the object. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: Indicates the checksum type that you want Amazon S3 to use + to calculate the object’s checksum value. For more information, see [Checking + object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + CreateMultipartUploadRequest: + type: object + properties: + ACL: + $ref: '#/components/schemas/ObjectCannedACL' + description: "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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL)\ + \ in the _Amazon S3 User Guide_.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).\ + \ One way to grant the permissions using the request headers is to specify\ + \ a canned ACL with the `x-amz-acl` request header.\n\n * This functionality\ + \ is not supported for directory buckets.\n\n * This functionality is\ + \ not supported for Amazon S3 on Outposts." + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + CacheControl: + $ref: '#/components/schemas/CacheControl' + description: Specifies caching behavior along the request/reply chain. + ContentDisposition: + $ref: '#/components/schemas/ContentDisposition' + description: Specifies presentational information for the object. + ContentEncoding: + $ref: '#/components/schemas/ContentEncoding' + description: '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.' + ContentLanguage: + $ref: '#/components/schemas/ContentLanguage' + description: The language that the content is in. + ContentType: + $ref: '#/components/schemas/ContentType' + description: A standard MIME type describing the format of the object data. + Expires: + $ref: '#/components/schemas/Expires' + description: The date and time at which the object is no longer cacheable. + GrantFullControl: + $ref: '#/components/schemas/GrantFullControl' + description: "Specify access permissions explicitly to give the grantee\ + \ READ, READ_ACP, and WRITE_ACP permissions on the object.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ + \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ + \ pair, where the type is one of the following:\n\n * `id` – if the value\ + \ specified is the canonical user ID of an Amazon Web Services account\n\ + \n * `uri` – if you are granting permissions to a predefined group\n\n\ + \ * `emailAddress` – if the value specified is the email address of an\ + \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ + \ is only supported in the following Amazon Web Services Regions:\n\n\ + \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ + \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ + \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ + \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ + \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ + \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ + `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ + \ functionality is not supported for directory buckets.\n\n * This functionality\ + \ is not supported for Amazon S3 on Outposts." + GrantRead: + $ref: '#/components/schemas/GrantRead' + description: "Specify access permissions explicitly to allow grantee to\ + \ read the object data and its metadata.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ + \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ + \ pair, where the type is one of the following:\n\n * `id` – if the value\ + \ specified is the canonical user ID of an Amazon Web Services account\n\ + \n * `uri` – if you are granting permissions to a predefined group\n\n\ + \ * `emailAddress` – if the value specified is the email address of an\ + \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ + \ is only supported in the following Amazon Web Services Regions:\n\n\ + \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ + \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ + \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ + \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ + \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ + \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ + `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ + \ functionality is not supported for directory buckets.\n\n * This functionality\ + \ is not supported for Amazon S3 on Outposts." + GrantReadACP: + $ref: '#/components/schemas/GrantReadACP' + description: "Specify access permissions explicitly to allows grantee to\ + \ read the object ACL.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ + \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ + \ pair, where the type is one of the following:\n\n * `id` – if the value\ + \ specified is the canonical user ID of an Amazon Web Services account\n\ + \n * `uri` – if you are granting permissions to a predefined group\n\n\ + \ * `emailAddress` – if the value specified is the email address of an\ + \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ + \ is only supported in the following Amazon Web Services Regions:\n\n\ + \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ + \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ + \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ + \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ + \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ + \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ + `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ + \ functionality is not supported for directory buckets.\n\n * This functionality\ + \ is not supported for Amazon S3 on Outposts." + GrantWriteACP: + $ref: '#/components/schemas/GrantWriteACP' + description: "Specify access permissions explicitly to allows grantee to\ + \ allow grantee to write the ACL for the applicable object.\n\nBy 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ + \ in the _Amazon S3 User Guide_.\n\nYou specify each grantee as a type=value\ + \ pair, where the type is one of the following:\n\n * `id` – if the value\ + \ specified is the canonical user ID of an Amazon Web Services account\n\ + \n * `uri` – if you are granting permissions to a predefined group\n\n\ + \ * `emailAddress` – if the value specified is the email address of an\ + \ Amazon Web Services account\n\nUsing email addresses to specify a grantee\ + \ is only supported in the following Amazon Web Services Regions:\n\n\ + \ * US East (N. Virginia)\n\n * US West (N. California)\n\n *\ + \ US West (Oregon)\n\n * Asia Pacific (Singapore)\n\n * Asia Pacific\ + \ (Sydney)\n\n * Asia Pacific (Tokyo)\n\n * Europe (Ireland)\n\n\ + \ * South America (São Paulo)\n\nFor a list of all the Amazon S3 supported\ + \ Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\ + \ in the Amazon Web Services General Reference.\n\nFor 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:\n\n\ + `x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" `\n\n * This\ + \ functionality is not supported for directory buckets.\n\n * This functionality\ + \ is not supported for Amazon S3 on Outposts." + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload is to be initiated. + Metadata: + $ref: '#/components/schemas/Metadata' + description: A map of metadata to store with the object in S3. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: "The server-side encryption algorithm used when you store this\ + \ object in Amazon S3 or Amazon FSx.\n\n * **Directory buckets** \\-\ + \ For directory buckets, there are only two supported options for server-side\ + \ encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)\ + \ (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).\ + \ We recommend that the bucket's default encryption uses the desired encryption\ + \ configuration and you don't override the bucket default encryption in\ + \ your `CreateSession` requests or `PUT` object requests. Then, new objects\ + \ are automatically encrypted with the desired encryption settings. For\ + \ more information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ + \ in the _Amazon S3 User Guide_. For more information about the encryption\ + \ overriding behaviors in directory buckets, see [Specifying server-side\ + \ encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\ + \ \n\nIn the Zonal endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ + \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))\ + \ using the REST API, the encryption request headers must match the encryption\ + \ settings that are specified in the `CreateSession` request. You can't\ + \ override the values of the encryption settings (`x-amz-server-side-encryption`,\ + \ `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`,\ + \ and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified\ + \ in the `CreateSession` request. You don't need to explicitly specify\ + \ these encryption settings values in Zonal endpoint API calls, and Amazon\ + \ S3 will use the encryption settings values from the `CreateSession`\ + \ request to protect new objects in the directory bucket.\n\nWhen you\ + \ use the CLI or the Amazon Web Services SDKs, for `CreateSession`, the\ + \ session token refreshes automatically to avoid service interruptions\ + \ when a session expires. The CLI or the Amazon Web Services SDKs use\ + \ the bucket's default encryption configuration for the `CreateSession`\ + \ request. It's not supported to override the encryption settings values\ + \ in the `CreateSession` request. So in the Zonal endpoint API calls (except\ + \ [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ + \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),\ + \ the encryption request headers must match the default encryption configuration\ + \ of the directory bucket.\n\n * **S3 access points for Amazon FSx**\ + \ \\- When accessing data stored in Amazon FSx file systems using S3 access\ + \ points, the only valid server side encryption option is `aws:fsx`. All\ + \ Amazon FSx file systems have encryption configured by default and are\ + \ encrypted at rest. Data is automatically encrypted before being written\ + \ to the file system, and automatically decrypted as it is read. These\ + \ processes are handled transparently by Amazon FSx." + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: "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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)\ + \ in the _Amazon S3 User Guide_.\n\n * Directory buckets only support\ + \ `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability\ + \ Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class)\ + \ in Dedicated Local Zones.\n\n * Amazon S3 on Outposts only uses the\ + \ OUTPOSTS Storage Class." + WebsiteRedirectLocation: + $ref: '#/components/schemas/WebsiteRedirectLocation' + description: '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.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: 'Specifies the algorithm to use when encrypting the object + (for example, AES256). + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: 'Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to + use for object encryption. If the KMS key doesn''t exist in the same account + that''s issuing the command, you must use the full Key ARN not the Key + ID. + + + **General purpose buckets** \- If you specify `x-amz-server-side-encryption` + with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, + Key ARN, or Key Alias) of the KMS key to use. 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. + + + **Directory buckets** \- To encrypt data using SSE-KMS, it''s recommended + to specify the `x-amz-server-side-encryption` header to `aws:kms`. Then, + the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses + the bucket''s default KMS customer managed key ID. If you want to explicitly + set the ` x-amz-server-side-encryption-aws-kms-key-id` header, it must + match the bucket''s default customer managed key (using key ID or ARN, + not alias). Your SSE-KMS configuration can only support 1 [customer managed + key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) + per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + (`aws/s3`) isn''t supported. Incorrect key specification results in an + HTTP `400 Bad Request` error.' + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: 'Specifies the Amazon Web Services KMS Encryption Context to + use for object encryption. The value of this header is a Base64 encoded + string of a UTF-8 encoded JSON, which contains the encryption context + as key-value pairs. + + + **Directory buckets** \- You can optionally provide an explicit encryption + context value. The value must match the default encryption context - the + bucket Amazon Resource Name (ARN). An additional encryption context value + is not supported.' + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: '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). + + + **General purpose buckets** \- Setting this header to `true` causes Amazon + S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying + this header with a PUT action doesn''t affect bucket-level settings for + S3 Bucket Key. + + + **Directory buckets** \- S3 Bucket Keys are always enabled for `GET` and + `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket + Keys aren''t supported, when you copy SSE-KMS encrypted objects from general + purpose buckets to directory buckets, from directory buckets to general + purpose buckets, or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), + [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), + [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), + or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). + In this case, Amazon S3 makes a call to KMS every time a copy request + is made for a KMS-encrypted object.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + Tagging: + $ref: '#/components/schemas/TaggingHeader' + description: 'The tag-set for the object. The tag-set must be encoded as + URL Query parameters. + + + This functionality is not supported for directory buckets.' + ObjectLockMode: + $ref: '#/components/schemas/ObjectLockMode' + description: 'Specifies the Object Lock mode that you want to apply to the + uploaded object. + + + This functionality is not supported for directory buckets.' + ObjectLockRetainUntilDate: + $ref: '#/components/schemas/ObjectLockRetainUntilDate' + description: 'Specifies the date and time when you want the Object Lock + to expire. + + + This functionality is not supported for directory buckets.' + ObjectLockLegalHoldStatus: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: 'Specifies whether you want to apply a legal hold to the uploaded + object. + + + This functionality is not supported for directory buckets.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: Indicates the algorithm that you want Amazon S3 to use to create + the checksum for the object. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: Indicates the checksum type that you want Amazon S3 to use + to calculate the object’s checksum value. For more information, see [Checking + object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + required: + - Bucket + - Key + CreateSessionOutput: + type: object + properties: + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store objects + in the directory bucket. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If you specify `x-amz-server-side-encryption` with `aws:kms`, + this header indicates the ID of the KMS symmetric encryption customer + managed key that was used for object encryption. + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: If present, indicates the Amazon Web Services KMS Encryption + Context to use for object encryption. The value of this header is a Base64 + encoded string of a UTF-8 encoded JSON, which contains the encryption + context as key-value pairs. This value is stored as object metadata and + automatically gets passed on to Amazon Web Services KMS for future `GetObject` + operations on this object. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether to use an S3 Bucket Key for server-side encryption + with KMS keys (SSE-KMS). + Credentials: + $ref: '#/components/schemas/SessionCredentials' + description: The established temporary security credentials for the created + session. + required: + - Credentials + CreateSessionRequest: + type: object + properties: + SessionMode: + $ref: '#/components/schemas/SessionMode' + description: '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 API + operations on a directory bucket. A `ReadOnly` session is constrained + to execute the following Zonal endpoint API operations: `GetObject`, `HeadObject`, + `ListObjectsV2`, `GetObjectAttributes`, `ListParts`, and `ListMultipartUploads`.' + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket that you create a session for. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm to use when you store + objects in the directory bucket. + + + For directory buckets, there are only two supported options for server-side + encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) + (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). + By default, Amazon S3 encrypts data with SSE-S3. For more information, + see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html) + in the _Amazon S3 User Guide_. + + + **S3 access points for Amazon FSx** \- When accessing data stored in Amazon + FSx file systems using S3 access points, the only valid server side encryption + option is `aws:fsx`. All Amazon FSx file systems have encryption configured + by default and are encrypted at rest. Data is automatically encrypted + before being written to the file system, and automatically decrypted as + it is read. These processes are handled transparently by Amazon FSx.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: 'If you specify `x-amz-server-side-encryption` with `aws:kms`, + you must specify the ` x-amz-server-side-encryption-aws-kms-key-id` header + with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer + managed key to use. Otherwise, you get an HTTP `400 Bad Request` error. + Only use the key ID or key ARN. The key alias format of the KMS key isn''t + supported. Also, if the KMS key doesn''t exist in the same account that''t + issuing the command, you must use the full Key ARN not the Key ID. + + + Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) + per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + (`aws/s3`) isn''t supported.' + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: 'Specifies the Amazon Web Services KMS Encryption Context as + an additional encryption context to use for object encryption. The value + of this header is a Base64 encoded string of a UTF-8 encoded JSON, which + contains the encryption context as key-value pairs. This value is stored + as object metadata and automatically gets passed on to Amazon Web Services + KMS for future `GetObject` operations on this object. + + + **General purpose buckets** \- This value must be explicitly added during + `CopyObject` operations if you want an additional encryption context for + your object. For more information, see [Encryption context](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context) + in the _Amazon S3 User Guide_. + + + **Directory buckets** \- You can optionally provide an explicit encryption + context value. The value must match the default encryption context - the + bucket Amazon Resource Name (ARN). An additional encryption context value + is not supported.' + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: 'Specifies whether Amazon S3 should use an S3 Bucket Key for + object encryption with server-side encryption using KMS keys (SSE-KMS). + + + S3 Bucket Keys are always enabled for `GET` and `PUT` operations in a + directory bucket and can’t be disabled. S3 Bucket Keys aren''t supported, + when you copy SSE-KMS encrypted objects from general purpose buckets to + directory buckets, from directory buckets to general purpose buckets, + or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), + [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), + [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), + or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). + In this case, Amazon S3 makes a call to KMS every time a copy request + is made for a KMS-encrypted object.' + required: + - Bucket + CreationDate: + type: string + format: date-time + DataRedundancy: + type: string + enum: + - SingleAvailabilityZone + - SingleLocalZone + Date: + type: string + format: date-time + Days: + type: integer + DaysAfterInitiation: + type: integer + DefaultRetention: + type: object + properties: + Mode: + $ref: '#/components/schemas/ObjectLockRetentionMode' + description: The default Object Lock retention mode you want to apply to + new objects placed in the specified bucket. Must be used with either `Days` + or `Years`. + Days: + $ref: '#/components/schemas/Days' + description: The number of days that you want to specify for the default + retention period. Must be used with `Mode`. + Years: + $ref: '#/components/schemas/Years' + description: The number of years that you want to specify for the default + retention period. Must be used with `Mode`. + description: "The container element for optionally specifying the default Object\ + \ Lock retention settings for new objects placed in the specified bucket.\n\ + \n * The `DefaultRetention` settings require both a mode and a period.\n\n\ + \ * The `DefaultRetention` period can be either `Days` or `Years` but you\ + \ must select one. You cannot specify `Days` and `Years` at the same time." + Delete: + type: object + properties: + Objects: + $ref: '#/components/schemas/ObjectIdentifierList' + description: '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.' + Quiet: + $ref: '#/components/schemas/Quiet' + description: Element to enable quiet mode for the request. When you add + this element, you must set its value to `true`. + required: + - Objects + description: Container for the objects to delete. + DeleteBucketAnalyticsConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket from which an analytics configuration + is deleted. + Id: + $ref: '#/components/schemas/AnalyticsId' + description: The ID that identifies the analytics configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + DeleteBucketCorsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: Specifies the bucket whose `cors` configuration is being deleted. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + DeleteBucketEncryptionRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The name of the bucket containing the server-side encryption + configuration to delete. + + + **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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + DeleteBucketIntelligentTieringConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose configuration you want + to modify or retrieve. + Id: + $ref: '#/components/schemas/IntelligentTieringId' + description: The ID used to identify the S3 Intelligent-Tiering configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + DeleteBucketInventoryConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the inventory configuration + to delete. + Id: + $ref: '#/components/schemas/InventoryId' + description: The ID used to identify the inventory configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + DeleteBucketLifecycleRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name of the lifecycle to delete. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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). + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + required: + - Bucket + DeleteBucketMetadataConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that you want to remove the metadata + configuration from. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected bucket owner of the general purpose bucket that + you want to remove the metadata table configuration from. + required: + - Bucket + DeleteBucketMetadataTableConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that you want to remove the metadata + table configuration from. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected bucket owner of the general purpose bucket that + you want to remove the metadata table configuration from. + required: + - Bucket + DeleteBucketMetricsConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the metrics configuration + to delete. + Id: + $ref: '#/components/schemas/MetricsId' + description: The ID used to identify the metrics configuration. The ID has + a 64 character limit and can only contain letters, numbers, periods, dashes, + and underscores. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + DeleteBucketOwnershipControlsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The Amazon S3 bucket whose `OwnershipControls` you want to + delete. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + DeleteBucketPolicyRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + DeleteBucketReplicationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + DeleteBucketRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + DeleteBucketTaggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket that has the tag set to be removed. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + DeleteBucketWebsiteRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name for which you want to remove the website configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + DeleteMarker: + type: boolean + DeleteMarkerEntry: + type: object + properties: + Owner: + $ref: '#/components/schemas/Owner' + description: The account that created the delete marker. + Key: + $ref: '#/components/schemas/ObjectKey' + description: The object key. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: Version ID of an object. + IsLatest: + $ref: '#/components/schemas/IsLatest' + description: Specifies whether the object is (true) or is not (false) the + latest version of an object. + LastModified: + $ref: '#/components/schemas/LastModified' + description: Date and time when the object was last modified. + description: Information about the delete marker. + DeleteMarkerReplication: + type: object + properties: + Status: + $ref: '#/components/schemas/DeleteMarkerReplicationStatus' + description: 'Indicates whether to replicate delete markers. + + + Indicates whether to replicate delete markers.' + description: 'Specifies whether Amazon S3 replicates delete markers. If you + specify a `Filter` in your replication configuration, you must also include + a `DeleteMarkerReplication` element. If your `Filter` includes a `Tag` element, + the `DeleteMarkerReplication` `Status` must be set to Disabled, because Amazon + S3 does not support replicating delete markers for tag-based rules. For an + example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). + + + For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). + + + 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).' + DeleteMarkerReplicationStatus: + type: string + enum: + - Enabled + - Disabled + DeleteMarkerVersionId: + type: string + DeleteMarkers: + type: array + items: + $ref: '#/components/schemas/DeleteMarkerEntry' + DeleteObjectOutput: + type: object + properties: + DeleteMarker: + $ref: '#/components/schemas/DeleteMarker' + description: '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. To learn more about + delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). + + + This functionality is not supported for directory buckets.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Returns the version ID of the delete marker created as a result + of the DELETE operation. + + + This functionality is not supported for directory buckets.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + DeleteObjectRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Key name of the object to delete. + MFA: + $ref: '#/components/schemas/MFA' + description: '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.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + BypassGovernanceRetention: + $ref: '#/components/schemas/BypassGovernanceRetention' + description: '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.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + IfMatch: + $ref: '#/components/schemas/IfMatch' + description: 'Deletes the object if the ETag (entity tag) value provided + during the delete operation matches the ETag of the object in S3. If the + ETag values do not match, the operation returns a `412 Precondition Failed` + error. + + + Expects the ETag value as a string. `If-Match` does accept a string value + of an ''*'' (asterisk) character to denote a match of any ETag. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).' + IfMatchLastModifiedTime: + $ref: '#/components/schemas/IfMatchLastModifiedTime' + description: 'If present, the object is deleted only if its modification + times matches the provided `Timestamp`. If the `Timestamp` values do not + match, the operation returns a `412 Precondition Failed` error. If the + `Timestamp` matches or if the object doesn’t exist, the operation returns + a `204 Success (No Content)` response. + + + This functionality is only supported for directory buckets.' + IfMatchSize: + $ref: '#/components/schemas/IfMatchSize' + description: 'If present, the object is deleted only if its size matches + the provided size in bytes. If the `Size` value does not match, the operation + returns a `412 Precondition Failed` error. If the `Size` matches or if + the object doesn’t exist, the operation returns a `204 Success (No Content)` + response. + + + This functionality is only supported for directory buckets. + + + You can use the `If-Match`, `x-amz-if-match-last-modified-time` and `x-amz-if-match-size` + conditional headers in conjunction with each-other or individually.' + required: + - Bucket + - Key + DeleteObjectTaggingOutput: + type: object + properties: + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The versionId of the object the tag-set was removed from. + DeleteObjectTaggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket name containing the objects from which to remove + the tags. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key that identifies the object in the bucket from which + to remove all tags. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The versionId of the object that the tag-set will be removed + from. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + DeleteObjectsOutput: + type: object + properties: + Deleted: + $ref: '#/components/schemas/DeletedObjects' + description: Container element for a successful delete. It identifies the + object that was successfully deleted. + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + Errors: + $ref: '#/components/schemas/Errors' + description: Container for a failed delete action that describes the object + that Amazon S3 attempted to delete and the error it encountered. + DeleteObjectsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Delete: + $ref: '#/components/schemas/Delete' + description: Container for the request. + MFA: + $ref: '#/components/schemas/MFA' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + BypassGovernanceRetention: + $ref: '#/components/schemas/BypassGovernanceRetention' + description: '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.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: "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`.\n\nFor the `x-amz-checksum-_algorithm_ ` header,\ + \ replace ` _algorithm_ ` with the supported algorithm from the following\ + \ list:\n\n * `CRC32`\n\n * `CRC32C`\n\n * `CRC64NVME`\n\n * `SHA1`\n\ + \n * `SHA256`\n\nFor more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)\ + \ in the _Amazon S3 User Guide_.\n\nIf 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\ + \ fails the request with a `BadDigest` error.\n\nIf you provide an individual\ + \ checksum, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter." + required: + - Bucket + - Delete + DeletePublicAccessBlockRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The Amazon S3 bucket whose `PublicAccessBlock` configuration + you want to delete. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + DeletedObject: + type: object + properties: + Key: + $ref: '#/components/schemas/ObjectKey' + description: The name of the deleted object. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'The version ID of the deleted object. + + + This functionality is not supported for directory buckets.' + DeleteMarker: + $ref: '#/components/schemas/DeleteMarker' + description: '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. To learn more about + delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). + + + This functionality is not supported for directory buckets.' + DeleteMarkerVersionId: + $ref: '#/components/schemas/DeleteMarkerVersionId' + description: '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.' + description: Information about the deleted object. + DeletedObjects: + type: array + items: + $ref: '#/components/schemas/DeletedObject' + Delimiter: + type: string + Description: + type: string + Destination: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The Amazon Resource Name (ARN) of the bucket where you want + Amazon S3 to store the results. + Account: + $ref: '#/components/schemas/AccountId' + description: 'Destination bucket owner account ID. In a cross-account scenario, + if you direct Amazon S3 to change replica ownership to the Amazon Web + Services account that owns the destination bucket by specifying the `AccessControlTranslation` + property, this is the account ID of the destination bucket owner. For + more information, see [Replication Additional Configuration: Changing + the Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html) + in the _Amazon S3 User Guide_.' + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: 'The storage class to use when replicating objects, such as + S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage + class of the source object to create the object replica. + + + For valid values, see the `StorageClass` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) + action in the _Amazon S3 API Reference_. + + + `FSX_OPENZFS` is not an accepted value when replicating objects.' + AccessControlTranslation: + $ref: '#/components/schemas/AccessControlTranslation' + description: Specify this only in a cross-account scenario (where source + and destination bucket owners are not the same), and you want to change + replica ownership to the Amazon Web Services account that owns the destination + bucket. If this is not specified in the replication configuration, the + replicas are owned by same Amazon Web Services account that owns the source + object. + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: A container that provides information about encryption. If + `SourceSelectionCriteria` is specified, you must specify this element. + ReplicationTime: + $ref: '#/components/schemas/ReplicationTime' + description: A container specifying S3 Replication Time Control (S3 RTC), + including whether S3 RTC is enabled and the time when all objects and + operations on objects must be replicated. Must be specified together with + a `Metrics` block. + Metrics: + $ref: '#/components/schemas/Metrics' + description: A container specifying replication metrics-related settings + enabling replication metrics and events. + required: + - Bucket + description: Specifies information about where to publish analysis or configuration + results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). + DestinationResult: + type: object + properties: + TableBucketType: + $ref: '#/components/schemas/S3TablesBucketType' + description: The type of the table bucket where the metadata configuration + is stored. The `aws` value indicates an Amazon Web Services managed table + bucket, and the `customer` value indicates a customer-managed table bucket. + V2 metadata configurations are stored in Amazon Web Services managed table + buckets, and V1 metadata configurations are stored in customer-managed + table buckets. + TableBucketArn: + $ref: '#/components/schemas/S3TablesBucketArn' + description: The Amazon Resource Name (ARN) of the table bucket where the + metadata configuration is stored. + TableNamespace: + $ref: '#/components/schemas/S3TablesNamespace' + description: The namespace in the table bucket where the metadata tables + for a metadata configuration are stored. + description: The destination information for the S3 Metadata configuration. + DirectoryBucketToken: + type: string + minLength: 0 + maxLength: 1024 + DisplayName: + type: string + ETag: + type: string + EmailAddress: + type: string + EnableRequestProgress: + type: boolean + EncodingType: + type: string + enum: + - url + description: "

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are\n encoded only in UTF-8.\ + \ An object key can contain any Unicode character. However, the XML 1.0 parser\n\ + \ can't parse certain characters, such as characters with an ASCII value\ + \ from 0 to 10. For characters that\n aren't supported in XML 1.0, you\ + \ can add this parameter to request that Amazon S3 encode the keys in the\n\ + \ response. For more information about characters to avoid in object\ + \ key names, see Object key\n naming guidelines.

\n \n \ + \

When using the URL encoding type, non-ASCII characters that are used\ + \ in an object's key name will\n be percent-encoded according to UTF-8\ + \ code values. For example, the object\n test_file(3).png\ + \ will appear as test_file%283%29.png.

\n " + Encryption: + type: object + properties: + EncryptionType: + $ref: '#/components/schemas/ServerSideEncryption' + description: The server-side encryption algorithm used when storing job + results in Amazon S3 (for example, AES256, `aws:kms`). + KMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If the encryption type is `aws:kms`, this optional value specifies + the ID of the symmetric encryption customer managed key to use for encryption + of job results. Amazon S3 only supports symmetric encryption KMS keys. + For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + in the _Amazon Web Services Key Management Service Developer Guide_. + KMSContext: + $ref: '#/components/schemas/KMSContext' + description: If the encryption type is `aws:kms`, this optional value can + be used to specify the encryption context for the restore results. + required: + - EncryptionType + description: Contains the type of server-side encryption used. + EncryptionConfiguration: + type: object + properties: + ReplicaKmsKeyID: + $ref: '#/components/schemas/ReplicaKmsKeyID' + description: Specifies the ID (Key ARN or Alias ARN) of the customer managed + Amazon Web Services KMS key stored in Amazon Web Services Key Management + Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt + replica objects. Amazon S3 only supports symmetric encryption KMS keys. + For more information, see [Asymmetric keys in Amazon Web Services KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + in the _Amazon Web Services Key Management Service Developer Guide_. + description: 'Specifies encryption-related information for an Amazon S3 bucket + that is a destination for replicated objects. + + + If you''re specifying a customer managed KMS key, we recommend using a fully + qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves + the key within the requester’s account. This behavior can result in data that''s + encrypted with a KMS key that belongs to the requester, and not the bucket + owner.' + EncryptionType: + type: string + enum: + - NONE + - SSE-C + EncryptionTypeList: + type: array + items: + $ref: '#/components/schemas/EncryptionType' + EncryptionTypeMismatch: + type: object + properties: {} + description: The existing object was created with a different encryption type. + Subsequent write requests must include the appropriate encryption parameters + in the request or while creating the session. + End: + type: integer + format: int64 + EndEvent: + type: object + properties: {} + description: A message that indicates the request is complete and no more messages + will be sent. You should not assume that the request is complete until the + client receives an `EndEvent`. + Error: + type: object + properties: + Key: + $ref: '#/components/schemas/ObjectKey' + description: The error key. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'The version ID of the error. + + + This functionality is not supported for directory buckets.' + Code: + $ref: '#/components/schemas/Code' + description: "The error code is a string that uniquely identifies an error\ + \ condition. It is meant to be read and understood by programs that detect\ + \ and handle errors by type. The following is a list of Amazon S3 error\ + \ codes. For more information, see [Error responses](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html).\n\ + \n * * _Code:_ AccessDenied \n\n * _Description:_ Access Denied\n\ + \n * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ AccountProblem\n\n * _Description:_ There\ + \ is a problem with your Amazon Web Services account that prevents the\ + \ action from completing successfully. Contact Amazon Web Services Support\ + \ for further assistance.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ AllAccessDisabled\n\ + \n * _Description:_ All access to this Amazon S3 resource has been\ + \ disabled. Contact Amazon Web Services Support for further assistance.\n\ + \n * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ AmbiguousGrantByEmailAddress\n\n * _Description:_\ + \ The email address you provided is associated with more than one account.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ AuthorizationHeaderMalformed\n\n\ + \ * _Description:_ The authorization header you provided is invalid.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _HTTP Status Code:_\ + \ N/A\n\n * * _Code:_ BadDigest\n\n * _Description:_ The Content-MD5\ + \ you specified did not match what we received.\n\n * _HTTP Status\ + \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ + \ * * _Code:_ BucketAlreadyExists\n\n * _Description:_ The requested\ + \ bucket name is not available. The bucket namespace is shared by all\ + \ users of the system. Please select a different name and try again.\n\ + \n * _HTTP Status Code:_ 409 Conflict\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ BucketAlreadyOwnedByYou\n\n * _Description:_\ + \ 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).\n\ + \n * _Code:_ 409 Conflict (in all Regions except the North Virginia\ + \ Region) \n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ BucketNotEmpty\n\n * _Description:_ The bucket you tried to delete\ + \ is not empty.\n\n * _HTTP Status Code:_ 409 Conflict\n\n * _SOAP\ + \ Fault Code Prefix:_ Client\n\n * * _Code:_ CredentialsNotSupported\n\ + \n * _Description:_ This request does not support credentials.\n\n\ + \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ CrossLocationLoggingProhibited\n\n *\ + \ _Description:_ Cross-location logging not allowed. Buckets in one geographic\ + \ location cannot log information to a bucket in another location.\n\n\ + \ * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ EntityTooSmall\n\n * _Description:_ Your\ + \ proposed upload is smaller than the minimum allowed object size.\n\n\ + \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ EntityTooLarge\n\n * _Description:_ Your\ + \ proposed upload exceeds the maximum allowed object size.\n\n * _HTTP\ + \ Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\ + \n * * _Code:_ ExpiredToken\n\n * _Description:_ The provided\ + \ token has expired.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ IllegalVersioningConfigurationException\ + \ \n\n * _Description:_ Indicates that the versioning configuration\ + \ specified in the request is invalid.\n\n * _HTTP Status Code:_ 400\ + \ Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ IncompleteBody\n\n * _Description:_ You did not provide the number\ + \ of bytes specified by the Content-Length HTTP header\n\n * _HTTP\ + \ Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\ + \n * * _Code:_ IncorrectNumberOfFilesInPostRequest\n\n * _Description:_\ + \ POST requires exactly one file upload per request.\n\n * _HTTP Status\ + \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ + \ * * _Code:_ InlineDataTooLarge\n\n * _Description:_ Inline data\ + \ exceeds the maximum allowed size.\n\n * _HTTP Status Code:_ 400 Bad\ + \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ InternalError\n\n * _Description:_ We encountered an internal error.\ + \ Please try again.\n\n * _HTTP Status Code:_ 500 Internal Server Error\n\ + \n * _SOAP Fault Code Prefix:_ Server\n\n * * _Code:_ InvalidAccessKeyId\n\ + \n * _Description:_ The Amazon Web Services access key ID you provided\ + \ does not exist in our records.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidAddressingHeader\n\ + \n * _Description:_ You must specify the Anonymous role.\n\n * _HTTP\ + \ Status Code:_ N/A\n\n * _SOAP Fault Code Prefix:_ Client\n\n * \ + \ * _Code:_ InvalidArgument\n\n * _Description:_ Invalid Argument\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ InvalidBucketName\n\n * _Description:_\ + \ The specified bucket is not valid.\n\n * _HTTP Status Code:_ 400\ + \ Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ InvalidBucketState\n\n * _Description:_ The request is not valid\ + \ with the current state of the bucket.\n\n * _HTTP Status Code:_ 409\ + \ Conflict\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ InvalidDigest\n\n * _Description:_ The Content-MD5 you specified\ + \ is not valid.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n *\ + \ _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidEncryptionAlgorithmError\n\ + \n * _Description:_ The encryption request you specified is not valid.\ + \ The valid value is AES256.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidLocationConstraint\n\ + \n * _Description:_ The specified location constraint is not valid.\ + \ For more information about Regions, see [How to Select a Region for\ + \ Your Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).\ + \ \n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ InvalidObjectState\n\n * _Description:_\ + \ The action is not valid for the current state of the object.\n\n \ + \ * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ InvalidPart\n\n * _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.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidPartOrder\n\ + \n * _Description:_ The list of parts was not in ascending order. Parts\ + \ list must be specified in order by part number.\n\n * _HTTP Status\ + \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ + \ * * _Code:_ InvalidPayer\n\n * _Description:_ All access to\ + \ this object has been disabled. Please contact Amazon Web Services Support\ + \ for further assistance.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidPolicyDocument\n\ + \n * _Description:_ The content of the form does not meet the conditions\ + \ specified in the policy document.\n\n * _HTTP Status Code:_ 400 Bad\ + \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ InvalidRange\n\n * _Description:_ The requested range cannot be satisfied.\n\ + \n * _HTTP Status Code:_ 416 Requested Range Not Satisfiable\n\n \ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidRequest\n\ + \n * _Description:_ Please use `AWS4-HMAC-SHA256`.\n\n * _HTTP Status\ + \ Code:_ 400 Bad Request\n\n * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\ + \n * _Description:_ SOAP requests must be made over an HTTPS connection.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ InvalidRequest\n\n * _Description:_\ + \ Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS\ + \ compliant names.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n \ + \ * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\n * _Description:_\ + \ Amazon S3 Transfer Acceleration is not supported for buckets with periods\ + \ (.) in their names.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\n * _Description:_\ + \ Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _Code:_ N/A\n\n \ + \ * * _Code:_ InvalidRequest\n\n * _Description:_ Amazon S3 Transfer\ + \ Accelerate is not configured on this bucket.\n\n * _HTTP Status Code:_\ + \ 400 Bad Request\n\n * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\ + \n * _Description:_ Amazon S3 Transfer Accelerate is disabled on this\ + \ bucket.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _Code:_\ + \ N/A\n\n * * _Code:_ InvalidRequest\n\n * _Description:_ Amazon\ + \ S3 Transfer Acceleration is not supported on this bucket. Contact Amazon\ + \ Web Services Support for more information.\n\n * _HTTP Status Code:_\ + \ 400 Bad Request\n\n * _Code:_ N/A\n\n * * _Code:_ InvalidRequest\n\ + \n * _Description:_ Amazon S3 Transfer Acceleration cannot be enabled\ + \ on this bucket. Contact Amazon Web Services Support for more information.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _Code:_ N/A\n\n \ + \ * * _Code:_ InvalidSecurity\n\n * _Description:_ The provided\ + \ security credentials are not valid.\n\n * _HTTP Status Code:_ 403\ + \ Forbidden\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ InvalidSOAPRequest\n\n * _Description:_ The SOAP request body is\ + \ invalid.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ + \ Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidStorageClass\n\ + \n * _Description:_ The storage class you specified is not valid.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ InvalidTargetBucketForLogging\n\ + \n * _Description:_ The target bucket for logging does not exist, is\ + \ not owned by you, or does not have the appropriate grants for the log-delivery\ + \ group. \n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ + \ Fault Code Prefix:_ Client\n\n * * _Code:_ InvalidToken\n\n \ + \ * _Description:_ The provided token is malformed or otherwise invalid.\n\ + \n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ InvalidURI\n\n * _Description:_\ + \ Couldn't parse the specified URI.\n\n * _HTTP Status Code:_ 400 Bad\ + \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ KeyTooLongError\n\n * _Description:_ Your key is too long.\n\n \ + \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ MalformedACLError\n\n * _Description:_\ + \ The XML you provided was not well-formed or did not validate against\ + \ our published schema.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MalformedPOSTRequest\ + \ \n\n * _Description:_ The body of your POST request is not well-formed\ + \ multipart/form-data.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MalformedXML\n\ + \n * _Description:_ This happens when the user sends malformed XML\ + \ (XML that doesn't conform to the published XSD) for the configuration.\ + \ The error message is, \"The XML you provided was not well-formed or\ + \ did not validate against our published schema.\" \n\n * _HTTP Status\ + \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ + \ * * _Code:_ MaxMessageLengthExceeded\n\n * _Description:_ Your\ + \ request was too big.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MaxPostPreDataLengthExceededError\n\ + \n * _Description:_ Your POST request fields preceding the upload file\ + \ were too large.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n \ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MetadataTooLarge\n\ + \n * _Description:_ Your metadata headers exceed the maximum allowed\ + \ metadata size.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n *\ + \ _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MethodNotAllowed\n\ + \n * _Description:_ The specified method is not allowed against this\ + \ resource.\n\n * _HTTP Status Code:_ 405 Method Not Allowed\n\n \ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ MissingAttachment\n\ + \n * _Description:_ A SOAP attachment was expected, but none were found.\n\ + \n * _HTTP Status Code:_ N/A\n\n * _SOAP Fault Code Prefix:_ Client\n\ + \n * * _Code:_ MissingContentLength\n\n * _Description:_ You must\ + \ provide the Content-Length HTTP header.\n\n * _HTTP Status Code:_\ + \ 411 Length Required\n\n * _SOAP Fault Code Prefix:_ Client\n\n *\ + \ * _Code:_ MissingRequestBodyError\n\n * _Description:_ This happens\ + \ when the user sends an empty XML document as a request. The error message\ + \ is, \"Request body is empty.\" \n\n * _HTTP Status Code:_ 400 Bad\ + \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ MissingSecurityElement\n\n * _Description:_ The SOAP 1.1 request\ + \ is missing a security element.\n\n * _HTTP Status Code:_ 400 Bad\ + \ Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ MissingSecurityHeader\n\n * _Description:_ Your request is missing\ + \ a required header.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ NoLoggingStatusForKey\n\ + \n * _Description:_ There is no such thing as a logging status subresource\ + \ for a key.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ + \ Fault Code Prefix:_ Client\n\n * * _Code:_ NoSuchBucket\n\n \ + \ * _Description:_ The specified bucket does not exist.\n\n * _HTTP\ + \ Status Code:_ 404 Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\ + \n * * _Code:_ NoSuchBucketPolicy\n\n * _Description:_ The specified\ + \ bucket does not have a bucket policy.\n\n * _HTTP Status Code:_ 404\ + \ Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ NoSuchKey\n\n * _Description:_ The specified key does not exist.\n\ + \n * _HTTP Status Code:_ 404 Not Found\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ NoSuchLifecycleConfiguration\n\n * _Description:_\ + \ The lifecycle configuration does not exist. \n\n * _HTTP Status Code:_\ + \ 404 Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\n * *\ + \ _Code:_ NoSuchUpload\n\n * _Description:_ The specified multipart\ + \ upload does not exist. The upload ID might be invalid, or the multipart\ + \ upload might have been aborted or completed.\n\n * _HTTP Status Code:_\ + \ 404 Not Found\n\n * _SOAP Fault Code Prefix:_ Client\n\n * *\ + \ _Code:_ NoSuchVersion \n\n * _Description:_ Indicates that the version\ + \ ID specified in the request does not match an existing version.\n\n\ + \ * _HTTP Status Code:_ 404 Not Found\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ NotImplemented\n\n * _Description:_ A\ + \ header you provided implies functionality that is not implemented.\n\ + \n * _HTTP Status Code:_ 501 Not Implemented\n\n * _SOAP Fault Code\ + \ Prefix:_ Server\n\n * * _Code:_ NotSignedUp\n\n * _Description:_\ + \ Your account is not signed up for the Amazon S3 service. You must sign\ + \ up before you can use Amazon S3. You can sign up at the following URL:\ + \ [Amazon S3](http://aws.amazon.com/s3)\n\n * _HTTP Status Code:_ 403\ + \ Forbidden\n\n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_\ + \ OperationAborted\n\n * _Description:_ A conflicting conditional action\ + \ is currently in progress against this resource. Try again.\n\n *\ + \ _HTTP Status Code:_ 409 Conflict\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ PermanentRedirect\n\n * _Description:_\ + \ The bucket you are attempting to access must be addressed using the\ + \ specified endpoint. Send all future requests to this endpoint.\n\n \ + \ * _HTTP Status Code:_ 301 Moved Permanently\n\n * _SOAP Fault Code\ + \ Prefix:_ Client\n\n * * _Code:_ PreconditionFailed\n\n * _Description:_\ + \ At least one of the preconditions you specified did not hold.\n\n \ + \ * _HTTP Status Code:_ 412 Precondition Failed\n\n * _SOAP Fault\ + \ Code Prefix:_ Client\n\n * * _Code:_ Redirect\n\n * _Description:_\ + \ Temporary redirect.\n\n * _HTTP Status Code:_ 307 Moved Temporarily\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ RestoreAlreadyInProgress\n\ + \n * _Description:_ Object restore is already in progress.\n\n *\ + \ _HTTP Status Code:_ 409 Conflict\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ RequestIsNotMultiPartContent\n\n * _Description:_\ + \ Bucket POST must be of the enclosure-type multipart/form-data.\n\n \ + \ * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ RequestTimeout\n\n * _Description:_ Your\ + \ socket connection to the server was not read from or written to within\ + \ the timeout period.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ RequestTimeTooSkewed\n\ + \n * _Description:_ The difference between the request time and the\ + \ server's time is too large.\n\n * _HTTP Status Code:_ 403 Forbidden\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ RequestTorrentOfBucketError\n\ + \n * _Description:_ Requesting the torrent file of a bucket is not\ + \ permitted.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP\ + \ Fault Code Prefix:_ Client\n\n * * _Code:_ SignatureDoesNotMatch\n\ + \n * _Description:_ The request signature we calculated does not match\ + \ the signature you provided. Check your Amazon Web Services secret access\ + \ key and signing method. For more information, see [REST Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html)\ + \ and [SOAP Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html)\ + \ for details.\n\n * _HTTP Status Code:_ 403 Forbidden\n\n * _SOAP\ + \ Fault Code Prefix:_ Client\n\n * * _Code:_ ServiceUnavailable\n\ + \n * _Description:_ Service is unable to handle request.\n\n * _HTTP\ + \ Status Code:_ 503 Service Unavailable\n\n * _SOAP Fault Code Prefix:_\ + \ Server\n\n * * _Code:_ SlowDown\n\n * _Description:_ Reduce\ + \ your request rate.\n\n * _HTTP Status Code:_ 503 Slow Down\n\n \ + \ * _SOAP Fault Code Prefix:_ Server\n\n * * _Code:_ TemporaryRedirect\n\ + \n * _Description:_ You are being redirected to the bucket while DNS\ + \ updates.\n\n * _HTTP Status Code:_ 307 Moved Temporarily\n\n *\ + \ _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ TokenRefreshRequired\n\ + \n * _Description:_ The provided token must be refreshed.\n\n *\ + \ _HTTP Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_\ + \ Client\n\n * * _Code:_ TooManyBuckets\n\n * _Description:_ You\ + \ have attempted to create more buckets than allowed.\n\n * _HTTP Status\ + \ Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client\n\n\ + \ * * _Code:_ UnexpectedContent\n\n * _Description:_ This request\ + \ does not support content.\n\n * _HTTP Status Code:_ 400 Bad Request\n\ + \n * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ UnresolvableGrantByEmailAddress\n\ + \n * _Description:_ The email address you provided does not match any\ + \ account on record.\n\n * _HTTP Status Code:_ 400 Bad Request\n\n\ + \ * _SOAP Fault Code Prefix:_ Client\n\n * * _Code:_ UserKeyMustBeSpecified\n\ + \n * _Description:_ The bucket POST must contain the specified field\ + \ name. If it is specified, check the order of the fields.\n\n * _HTTP\ + \ Status Code:_ 400 Bad Request\n\n * _SOAP Fault Code Prefix:_ Client" + Message: + $ref: '#/components/schemas/Message' + description: The error message contains a generic description of the error + condition in English. It is intended for a human audience. Simple programs + display the message directly to the end user if they encounter an error + condition they don't know how or don't care to handle. Sophisticated programs + with more exhaustive error handling and proper internationalization are + more likely to ignore the error message. + description: Container for all error elements. + ErrorCode: + type: string + ErrorDetails: + type: object + properties: + ErrorCode: + $ref: '#/components/schemas/ErrorCode' + description: "If the V1 `CreateBucketMetadataTableConfiguration` request\ + \ succeeds, but S3 Metadata was unable to create the table, this structure\ + \ contains the error code. The possible error codes and error messages\ + \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ + \ have sufficient permissions to create the required resources. Make sure\ + \ that you have `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable`\ + \ and `s3tables:PutTablePolicy` permissions, and then try again. To create\ + \ a new metadata table, you must delete the metadata configuration for\ + \ this bucket, and then create a new metadata configuration. \n\n * `AccessDeniedWritingToTable`\ + \ \\- Unable to write to the metadata table because of missing resource\ + \ permissions. To fix the resource policy, Amazon S3 needs to create a\ + \ new metadata table. To create a new metadata table, you must delete\ + \ the metadata configuration for this bucket, and then create a new metadata\ + \ configuration.\n\n * `DestinationTableNotFound` \\- The destination\ + \ table doesn't exist. To create a new metadata table, you must delete\ + \ the metadata configuration for this bucket, and then create a new metadata\ + \ configuration.\n\n * `ServerInternalError` \\- An internal error has\ + \ occurred. To create a new metadata table, you must delete the metadata\ + \ configuration for this bucket, and then create a new metadata configuration.\n\ + \n * `TableAlreadyExists` \\- The table that you specified already exists\ + \ in the table bucket's namespace. Specify a different table name. To\ + \ create a new metadata table, you must delete the metadata configuration\ + \ for this bucket, and then create a new metadata configuration.\n\n \ + \ * `TableBucketNotFound` \\- The table bucket that you specified doesn't\ + \ exist in this Amazon Web Services Region and account. Create or choose\ + \ a different table bucket. To create a new metadata table, you must delete\ + \ the metadata configuration for this bucket, and then create a new metadata\ + \ configuration.\n\nIf the V2 `CreateBucketMetadataConfiguration` request\ + \ succeeds, but S3 Metadata was unable to create the table, this structure\ + \ contains the error code. The possible error codes and error messages\ + \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ + \ have sufficient permissions to create the required resources. Make sure\ + \ that you have `s3tables:CreateTableBucket`, `s3tables:CreateNamespace`,\ + \ `s3tables:CreateTable`, `s3tables:GetTable`, `s3tables:PutTablePolicy`,\ + \ `kms:DescribeKey`, and `s3tables:PutTableEncryption` permissions. Additionally,\ + \ ensure that the KMS key used to encrypt the table still exists, is active\ + \ and has a resource policy granting access to the S3 service principals\ + \ '`maintenance.s3tables.amazonaws.com`' and '`metadata.s3.amazonaws.com`'.\ + \ To create a new metadata table, you must delete the metadata configuration\ + \ for this bucket, and then create a new metadata configuration. \n\n\ + \ * `AccessDeniedWritingToTable` \\- Unable to write to the metadata\ + \ table because of missing resource permissions. To fix the resource policy,\ + \ Amazon S3 needs to create a new metadata table. To create a new metadata\ + \ table, you must delete the metadata configuration for this bucket, and\ + \ then create a new metadata configuration.\n\n * `DestinationTableNotFound`\ + \ \\- The destination table doesn't exist. To create a new metadata table,\ + \ you must delete the metadata configuration for this bucket, and then\ + \ create a new metadata configuration.\n\n * `ServerInternalError` \\\ + - An internal error has occurred. To create a new metadata table, you\ + \ must delete the metadata configuration for this bucket, and then create\ + \ a new metadata configuration.\n\n * `JournalTableAlreadyExists` \\\ + - A journal table already exists in the Amazon Web Services managed table\ + \ bucket's namespace. Delete the journal table, and then try again. To\ + \ create a new metadata table, you must delete the metadata configuration\ + \ for this bucket, and then create a new metadata configuration.\n\n \ + \ * `InventoryTableAlreadyExists` \\- An inventory table already exists\ + \ in the Amazon Web Services managed table bucket's namespace. Delete\ + \ the inventory table, and then try again. To create a new metadata table,\ + \ you must delete the metadata configuration for this bucket, and then\ + \ create a new metadata configuration.\n\n * `JournalTableNotAvailable`\ + \ \\- The journal table that the inventory table relies on has a `FAILED`\ + \ status. An inventory table requires a journal table with an `ACTIVE`\ + \ status. To create a new journal or inventory table, you must delete\ + \ the metadata configuration for this bucket, along with any journal or\ + \ inventory tables, and then create a new metadata configuration.\n\n\ + \ * `NoSuchBucket` \\- The specified general purpose bucket does not\ + \ exist." + ErrorMessage: + $ref: '#/components/schemas/ErrorMessage' + description: "If the V1 `CreateBucketMetadataTableConfiguration` request\ + \ succeeds, but S3 Metadata was unable to create the table, this structure\ + \ contains the error message. The possible error codes and error messages\ + \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ + \ have sufficient permissions to create the required resources. Make sure\ + \ that you have `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable`\ + \ and `s3tables:PutTablePolicy` permissions, and then try again. To create\ + \ a new metadata table, you must delete the metadata configuration for\ + \ this bucket, and then create a new metadata configuration. \n\n * `AccessDeniedWritingToTable`\ + \ \\- Unable to write to the metadata table because of missing resource\ + \ permissions. To fix the resource policy, Amazon S3 needs to create a\ + \ new metadata table. To create a new metadata table, you must delete\ + \ the metadata configuration for this bucket, and then create a new metadata\ + \ configuration.\n\n * `DestinationTableNotFound` \\- The destination\ + \ table doesn't exist. To create a new metadata table, you must delete\ + \ the metadata configuration for this bucket, and then create a new metadata\ + \ configuration.\n\n * `ServerInternalError` \\- An internal error has\ + \ occurred. To create a new metadata table, you must delete the metadata\ + \ configuration for this bucket, and then create a new metadata configuration.\n\ + \n * `TableAlreadyExists` \\- The table that you specified already exists\ + \ in the table bucket's namespace. Specify a different table name. To\ + \ create a new metadata table, you must delete the metadata configuration\ + \ for this bucket, and then create a new metadata configuration.\n\n \ + \ * `TableBucketNotFound` \\- The table bucket that you specified doesn't\ + \ exist in this Amazon Web Services Region and account. Create or choose\ + \ a different table bucket. To create a new metadata table, you must delete\ + \ the metadata configuration for this bucket, and then create a new metadata\ + \ configuration.\n\nIf the V2 `CreateBucketMetadataConfiguration` request\ + \ succeeds, but S3 Metadata was unable to create the table, this structure\ + \ contains the error code. The possible error codes and error messages\ + \ are as follows:\n\n * `AccessDeniedCreatingResources` \\- You don't\ + \ have sufficient permissions to create the required resources. Make sure\ + \ that you have `s3tables:CreateTableBucket`, `s3tables:CreateNamespace`,\ + \ `s3tables:CreateTable`, `s3tables:GetTable`, `s3tables:PutTablePolicy`,\ + \ `kms:DescribeKey`, and `s3tables:PutTableEncryption` permissions. Additionally,\ + \ ensure that the KMS key used to encrypt the table still exists, is active\ + \ and has a resource policy granting access to the S3 service principals\ + \ '`maintenance.s3tables.amazonaws.com`' and '`metadata.s3.amazonaws.com`'.\ + \ To create a new metadata table, you must delete the metadata configuration\ + \ for this bucket, and then create a new metadata configuration. \n\n\ + \ * `AccessDeniedWritingToTable` \\- Unable to write to the metadata\ + \ table because of missing resource permissions. To fix the resource policy,\ + \ Amazon S3 needs to create a new metadata table. To create a new metadata\ + \ table, you must delete the metadata configuration for this bucket, and\ + \ then create a new metadata configuration.\n\n * `DestinationTableNotFound`\ + \ \\- The destination table doesn't exist. To create a new metadata table,\ + \ you must delete the metadata configuration for this bucket, and then\ + \ create a new metadata configuration.\n\n * `ServerInternalError` \\\ + - An internal error has occurred. To create a new metadata table, you\ + \ must delete the metadata configuration for this bucket, and then create\ + \ a new metadata configuration.\n\n * `JournalTableAlreadyExists` \\\ + - A journal table already exists in the Amazon Web Services managed table\ + \ bucket's namespace. Delete the journal table, and then try again. To\ + \ create a new metadata table, you must delete the metadata configuration\ + \ for this bucket, and then create a new metadata configuration.\n\n \ + \ * `InventoryTableAlreadyExists` \\- An inventory table already exists\ + \ in the Amazon Web Services managed table bucket's namespace. Delete\ + \ the inventory table, and then try again. To create a new metadata table,\ + \ you must delete the metadata configuration for this bucket, and then\ + \ create a new metadata configuration.\n\n * `JournalTableNotAvailable`\ + \ \\- The journal table that the inventory table relies on has a `FAILED`\ + \ status. An inventory table requires a journal table with an `ACTIVE`\ + \ status. To create a new journal or inventory table, you must delete\ + \ the metadata configuration for this bucket, along with any journal or\ + \ inventory tables, and then create a new metadata configuration.\n\n\ + \ * `NoSuchBucket` \\- The specified general purpose bucket does not\ + \ exist." + description: 'If an S3 Metadata V1 `CreateBucketMetadataTableConfiguration` + or V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata + was unable to create the table, this structure contains the error code and + error message. + + + If you created your S3 Metadata configuration before July 15, 2025, we recommend + that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) + so that you can expire journal table records and create a live inventory table.' + ErrorDocument: + type: object + properties: + Key: + $ref: '#/components/schemas/ObjectKey' + description: 'The object key name to use when a 4XX class error occurs. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + required: + - Key + description: The error information. + ErrorMessage: + type: string + Errors: + type: array + items: + $ref: '#/components/schemas/Error' + Event: + type: string + enum: + - s3:ReducedRedundancyLostObject + - s3:ObjectCreated:* + - s3:ObjectCreated:Put + - s3:ObjectCreated:Post + - s3:ObjectCreated:Copy + - s3:ObjectCreated:CompleteMultipartUpload + - s3:ObjectRemoved:* + - s3:ObjectRemoved:Delete + - s3:ObjectRemoved:DeleteMarkerCreated + - s3:ObjectRestore:* + - s3:ObjectRestore:Post + - s3:ObjectRestore:Completed + - s3:Replication:* + - s3:Replication:OperationFailedReplication + - s3:Replication:OperationNotTracked + - s3:Replication:OperationMissedThreshold + - s3:Replication:OperationReplicatedAfterThreshold + - s3:ObjectRestore:Delete + - s3:LifecycleTransition + - s3:IntelligentTiering + - s3:ObjectAcl:Put + - s3:LifecycleExpiration:* + - s3:LifecycleExpiration:Delete + - s3:LifecycleExpiration:DeleteMarkerCreated + - s3:ObjectTagging:* + - s3:ObjectTagging:Put + - s3:ObjectTagging:Delete + description:

The bucket event for which to send notifications.

+ EventBridgeConfiguration: + type: object + properties: {} + description: A container for specifying the configuration for Amazon EventBridge. + EventList: + type: array + items: + $ref: '#/components/schemas/Event' + ExistingObjectReplication: + type: object + properties: + Status: + $ref: '#/components/schemas/ExistingObjectReplicationStatus' + description: Specifies whether Amazon S3 replicates existing source bucket + objects. + required: + - Status + description: 'Optional configuration to replicate existing source bucket objects. + + + This parameter is no longer supported. To replicate existing objects, see + [Replicating existing objects with S3 Batch Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html) + in the _Amazon S3 User Guide_.' + ExistingObjectReplicationStatus: + type: string + enum: + - Enabled + - Disabled + Expiration: + type: string + ExpirationState: + type: string + enum: + - ENABLED + - DISABLED + ExpirationStatus: + type: string + enum: + - Enabled + - Disabled + ExpiredObjectDeleteMarker: + type: boolean + Expires: + type: string + ExposeHeader: + type: string + ExposeHeaders: + type: array + items: + $ref: '#/components/schemas/ExposeHeader' + Expression: + type: string + ExpressionType: + type: string + enum: + - SQL + FetchOwner: + type: boolean + FieldDelimiter: + type: string + FileHeaderInfo: + type: string + enum: + - USE + - IGNORE + - NONE + FilterRule: + type: object + properties: + Name: + $ref: '#/components/schemas/FilterRuleName' + description: The object key name prefix or suffix identifying one or more + objects to which the filtering rule applies. The maximum length is 1,024 + characters. Overlapping prefixes and suffixes are not supported. For more + information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + in the _Amazon S3 User Guide_. + Value: + $ref: '#/components/schemas/FilterRuleValue' + description: The value that the filter searches for in object key names. + description: Specifies the Amazon S3 object key name to filter on. An object + key name is the name assigned to an object in your Amazon S3 bucket. You specify + whether to filter on the suffix or prefix of the object key name. A prefix + is a specific string of characters at the beginning of an object key name, + which you can use to organize objects. For example, you can start the key + names of related objects with a prefix, such as `2023-` or `engineering/`. + Then, you can use `FilterRule` to find objects in a bucket with key names + that have the same prefix. A suffix is similar to a prefix, but it is at the + end of the object key name instead of at the beginning. + FilterRuleList: + type: array + items: + $ref: '#/components/schemas/FilterRule' + description:

A list of containers for the key-value pair that defines the + criteria for the filter rule.

+ FilterRuleName: + type: string + enum: + - prefix + - suffix + FilterRuleValue: + type: string + GetBucketAbacOutput: + type: object + properties: + AbacStatus: + $ref: '#/components/schemas/AbacStatus' + description: The ABAC status of the general purpose bucket. + GetBucketAbacRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the general purpose bucket. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The Amazon Web Services account ID of the general purpose bucket's + owner. + required: + - Bucket + GetBucketAccelerateConfigurationOutput: + type: object + properties: + Status: + $ref: '#/components/schemas/BucketAccelerateStatus' + description: The accelerate configuration of the bucket. + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + GetBucketAccelerateConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which the accelerate configuration + is retrieved. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + required: + - Bucket + GetBucketAclOutput: + type: object + properties: + Owner: + $ref: '#/components/schemas/Owner' + description: Container for the bucket owner's ID. + Grants: + $ref: '#/components/schemas/Grants' + description: A list of grants. + GetBucketAclRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketAnalyticsConfigurationOutput: + type: object + properties: + AnalyticsConfiguration: + $ref: '#/components/schemas/AnalyticsConfiguration' + description: The configuration and any analyses for the analytics filter. + GetBucketAnalyticsConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket from which an analytics configuration + is retrieved. + Id: + $ref: '#/components/schemas/AnalyticsId' + description: The ID that identifies the analytics configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + GetBucketCorsOutput: + type: object + properties: + CORSRules: + $ref: '#/components/schemas/CORSRules' + description: A set of origins and methods (cross-origin access that you + want to allow). You can add up to 100 rules to the configuration. + GetBucketCorsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketEncryptionOutput: + type: object + properties: + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + GetBucketEncryptionRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The name of the bucket from which the server-side encryption + configuration is retrieved. + + + **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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + GetBucketIntelligentTieringConfigurationOutput: + type: object + properties: + IntelligentTieringConfiguration: + $ref: '#/components/schemas/IntelligentTieringConfiguration' + description: Container for S3 Intelligent-Tiering configuration. + GetBucketIntelligentTieringConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose configuration you want + to modify or retrieve. + Id: + $ref: '#/components/schemas/IntelligentTieringId' + description: The ID used to identify the S3 Intelligent-Tiering configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + GetBucketInventoryConfigurationOutput: + type: object + properties: + InventoryConfiguration: + $ref: '#/components/schemas/InventoryConfiguration' + description: Specifies the inventory configuration. + GetBucketInventoryConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the inventory configuration + to retrieve. + Id: + $ref: '#/components/schemas/InventoryId' + description: The ID used to identify the inventory configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + GetBucketLifecycleConfigurationOutput: + type: object + properties: + Rules: + $ref: '#/components/schemas/LifecycleRules' + description: Container for a lifecycle rule. + TransitionDefaultMinimumObjectSize: + $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' + description: "Indicates which default minimum object size behavior is applied\ + \ to the lifecycle configuration.\n\nThis parameter applies to general\ + \ purpose buckets only. It isn't supported for directory bucket lifecycle\ + \ configurations.\n\n * `all_storage_classes_128K` \\- Objects smaller\ + \ than 128 KB will not transition to any storage class by default.\n\n\ + \ * `varies_by_storage_class` \\- Objects smaller than 128 KB will transition\ + \ to Glacier Flexible Retrieval or Glacier Deep Archive storage classes.\ + \ By default, all other storage classes will prevent transitions smaller\ + \ than 128 KB. \n\nTo customize the minimum object size for any transition\ + \ you can add a filter that specifies a custom `ObjectSizeGreaterThan`\ + \ or `ObjectSizeLessThan` in the body of your transition rule. Custom\ + \ filters always take precedence over the default transition behavior." + GetBucketLifecycleConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which to get the lifecycle information. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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). + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + required: + - Bucket + GetBucketLocationOutput: + type: object + properties: + LocationConstraint: + $ref: '#/components/schemas/BucketLocationConstraint' + description: 'Specifies the Region where the bucket resides. For a list + of all the Amazon S3 supported location constraints by Region, see [Regions + and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). + + + Buckets in Region `us-east-1` have a LocationConstraint of `null`. Buckets + with a LocationConstraint of `EU` reside in `eu-west-1`.' + GetBucketLocationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketLoggingOutput: + type: object + properties: + LoggingEnabled: + $ref: '#/components/schemas/LoggingEnabled' + GetBucketLoggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name for which to get the logging information. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketMetadataConfigurationOutput: + type: object + properties: + GetBucketMetadataConfigurationResult: + $ref: '#/components/schemas/GetBucketMetadataConfigurationResult' + description: The metadata configuration for the general purpose bucket. + GetBucketMetadataConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that corresponds to the metadata + configuration that you want to retrieve. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected owner of the general purpose bucket that you want + to retrieve the metadata table configuration for. + required: + - Bucket + GetBucketMetadataConfigurationResult: + type: object + properties: + MetadataConfigurationResult: + $ref: '#/components/schemas/MetadataConfigurationResult' + description: The metadata configuration for a general purpose bucket. + required: + - MetadataConfigurationResult + description: The S3 Metadata configuration for a general purpose bucket. + GetBucketMetadataTableConfigurationOutput: + type: object + properties: + GetBucketMetadataTableConfigurationResult: + $ref: '#/components/schemas/GetBucketMetadataTableConfigurationResult' + description: The metadata table configuration for the general purpose bucket. + GetBucketMetadataTableConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that corresponds to the metadata + table configuration that you want to retrieve. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected owner of the general purpose bucket that you want + to retrieve the metadata table configuration for. + required: + - Bucket + GetBucketMetadataTableConfigurationResult: + type: object + properties: + MetadataTableConfigurationResult: + $ref: '#/components/schemas/MetadataTableConfigurationResult' + description: The V1 S3 Metadata configuration for a general purpose bucket. + Status: + $ref: '#/components/schemas/MetadataTableStatus' + description: "The status of the metadata table. The status values are:\n\ + \n * `CREATING` \\- The metadata table is in the process of being created\ + \ in the specified table bucket.\n\n * `ACTIVE` \\- The metadata table\ + \ has been created successfully, and records are being delivered to the\ + \ table. \n\n * `FAILED` \\- Amazon S3 is unable to create the metadata\ + \ table, or Amazon S3 is unable to deliver records. See `ErrorDetails`\ + \ for details." + Error: + $ref: '#/components/schemas/ErrorDetails' + description: If the `CreateBucketMetadataTableConfiguration` request succeeds, + but S3 Metadata was unable to create the table, this structure contains + the error code and error message. + required: + - MetadataTableConfigurationResult + - Status + description: 'The V1 S3 Metadata configuration for a general purpose bucket. + + + If you created your S3 Metadata configuration before July 15, 2025, we recommend + that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) + so that you can expire journal table records and create a live inventory table.' + GetBucketMetricsConfigurationOutput: + type: object + properties: + MetricsConfiguration: + $ref: '#/components/schemas/MetricsConfiguration' + description: Specifies the metrics configuration. + GetBucketMetricsConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the metrics configuration + to retrieve. + Id: + $ref: '#/components/schemas/MetricsId' + description: The ID used to identify the metrics configuration. The ID has + a 64 character limit and can only contain letters, numbers, periods, dashes, + and underscores. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + GetBucketNotificationConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketOwnershipControlsOutput: + type: object + properties: + OwnershipControls: + $ref: '#/components/schemas/OwnershipControls' + description: The `OwnershipControls` (BucketOwnerEnforced, BucketOwnerPreferred, + or ObjectWriter) currently in effect for this Amazon S3 bucket. + GetBucketOwnershipControlsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose `OwnershipControls` + you want to retrieve. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketPolicyOutput: + type: object + properties: + Policy: + $ref: '#/components/schemas/Policy' + description: The bucket policy as a JSON document. + GetBucketPolicyRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). + + + Object Lambda access points are not supported by directory buckets.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + GetBucketPolicyStatusOutput: + type: object + properties: + PolicyStatus: + $ref: '#/components/schemas/PolicyStatus' + description: The policy status for the specified bucket. + GetBucketPolicyStatusRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose policy status you want + to retrieve. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketReplicationOutput: + type: object + properties: + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + GetBucketReplicationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name for which to get the replication information. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketRequestPaymentOutput: + type: object + properties: + Payer: + $ref: '#/components/schemas/Payer' + description: Specifies who pays for the download and request fees. + GetBucketRequestPaymentRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which to get the payment request + configuration + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketTaggingOutput: + type: object + properties: + TagSet: + $ref: '#/components/schemas/TagSet' + description: Contains the tag set. + required: + - TagSet + GetBucketTaggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which to get the tagging information. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketVersioningOutput: + type: object + properties: + Status: + $ref: '#/components/schemas/BucketVersioningStatus' + description: The versioning state of the bucket. + MFADelete: + $ref: '#/components/schemas/MFADeleteStatus' + description: Specifies whether MFA delete is enabled in the bucket versioning + configuration. This element is only returned if the bucket has been configured + with MFA delete. If the bucket has never been so configured, this element + is not returned. + GetBucketVersioningRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which to get the versioning information. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetBucketWebsiteOutput: + type: object + properties: + RedirectAllRequestsTo: + $ref: '#/components/schemas/RedirectAllRequestsTo' + description: Specifies the redirect behavior of all requests to a website + endpoint of an Amazon S3 bucket. + IndexDocument: + $ref: '#/components/schemas/IndexDocument' + description: The name of the index document for the website (for example + `index.html`). + ErrorDocument: + $ref: '#/components/schemas/ErrorDocument' + description: The object key name of the website error document to use for + 4XX class errors. + RoutingRules: + $ref: '#/components/schemas/RoutingRules' + description: Rules that define when a redirect is applied and the redirect + behavior. + GetBucketWebsiteRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name for which to get the website configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetObjectAclOutput: + type: object + properties: + Owner: + $ref: '#/components/schemas/Owner' + description: Container for the bucket owner's ID. + Grants: + $ref: '#/components/schemas/Grants' + description: A list of grants. + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + GetObjectAclRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key of the object for which to get the ACL information. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID used to reference a specific version of the object. + + + This functionality is not supported for directory buckets.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + GetObjectAttributesOutput: + type: object + properties: + DeleteMarker: + $ref: '#/components/schemas/DeleteMarker' + description: '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. To learn more about delete markers, see [Working + with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). + + + This functionality is not supported for directory buckets.' + LastModified: + $ref: '#/components/schemas/LastModified' + description: Date and time when the object was last modified. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'The version ID of the object. + + + This functionality is not supported for directory buckets.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ETag: + $ref: '#/components/schemas/ETag' + description: An ETag is an opaque identifier assigned by a web server to + a specific version of a resource found at a URL. + Checksum: + $ref: '#/components/schemas/Checksum' + description: The checksum or digest of the object. + ObjectParts: + $ref: '#/components/schemas/GetObjectAttributesParts' + description: A collection of parts associated with a multipart upload. + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). + + + **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` + (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` + (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' + ObjectSize: + $ref: '#/components/schemas/ObjectSize' + description: The size of the object in bytes. + GetObjectAttributesParts: + type: object + properties: + TotalPartsCount: + $ref: '#/components/schemas/PartsCount' + description: The total number of parts. + PartNumberMarker: + $ref: '#/components/schemas/PartNumberMarker' + description: The marker for the current part. + NextPartNumberMarker: + $ref: '#/components/schemas/NextPartNumberMarker' + description: When a list is truncated, this element specifies the last part + in the list, as well as the value to use for the `PartNumberMarker` request + parameter in a subsequent request. + MaxParts: + $ref: '#/components/schemas/MaxParts' + description: The maximum number of parts allowed in the response. + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Indicates whether the returned list of parts is truncated. + A value of `true` indicates that the list was truncated. A list can be + truncated if the number of parts exceeds the limit returned in the `MaxParts` + element. + Parts: + $ref: '#/components/schemas/PartsList' + description: "A container for elements related to a particular part. A response\ + \ can contain zero or more `Parts` elements.\n\n * **General purpose\ + \ buckets** \\- For `GetObjectAttributes`, if an 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 the `Part` element.\n\n *\ + \ **Directory buckets** \\- For `GetObjectAttributes`, regardless of whether\ + \ an additional checksum is applied to the object specified in the request,\ + \ the response returns the `Part` element." + description: A collection of parts associated with a multipart upload. + GetObjectAttributesRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The object key. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: '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.' + MaxParts: + $ref: '#/components/schemas/MaxParts' + description: Sets the maximum number of parts to return. For more information, + see [Uploading and copying objects using multipart upload in Amazon S3 + ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html) + in the _Amazon Simple Storage Service user guide_. + PartNumberMarker: + $ref: '#/components/schemas/PartNumberMarker' + description: Specifies the part after which listing should begin. Only parts + with higher part numbers will be listed. For more information, see [Uploading + and copying objects using multipart upload in Amazon S3 ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html) + in the _Amazon Simple Storage Service user guide_. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: 'Specifies the algorithm to use when encrypting the object + (for example, AES256). + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ObjectAttributes: + $ref: '#/components/schemas/ObjectAttributesList' + description: Specifies the fields at the root level that you want returned + in the response. Fields that you do not specify are not returned. + required: + - Bucket + - Key + - ObjectAttributes + GetObjectLegalHoldOutput: + type: object + properties: + LegalHold: + $ref: '#/components/schemas/ObjectLockLegalHold' + description: The current legal hold status for the specified object. + GetObjectLegalHoldRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key name for the object whose legal hold status you want + to retrieve. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The version ID of the object whose legal hold status you want + to retrieve. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + GetObjectLockConfigurationOutput: + type: object + properties: + ObjectLockConfiguration: + $ref: '#/components/schemas/ObjectLockConfiguration' + description: The specified bucket's Object Lock configuration. + GetObjectLockConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket whose Object Lock configuration you want to retrieve. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GetObjectOutput: + type: object + properties: + Body: + $ref: '#/components/schemas/StreamingBlob' + description: Object data. + DeleteMarker: + $ref: '#/components/schemas/DeleteMarker' + description: "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.\n\n * 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.\n\n * 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." + AcceptRanges: + $ref: '#/components/schemas/AcceptRanges' + description: Indicates that a range of bytes was specified in the request. + Expiration: + $ref: '#/components/schemas/Expiration' + description: 'If the object expiration is configured (see [ `PutBucketLifecycleConfiguration` + ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)), + 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. + + + Object expiration information is not returned in directory buckets and + this header returns the value "`NotImplemented`" in all responses for + directory buckets.' + Restore: + $ref: '#/components/schemas/Restore' + description: 'Provides information about object restoration action and expiration + time of the restored object copy. + + + This functionality is not supported for directory buckets. Directory buckets + only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) + in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access + storage class) in Dedicated Local Zones.' + LastModified: + $ref: '#/components/schemas/LastModified' + description: '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.' + ContentLength: + $ref: '#/components/schemas/ContentLength' + description: Size of the body in bytes. + ETag: + $ref: '#/components/schemas/ETag' + description: An entity tag (ETag) is an opaque identifier assigned by a + web server to a specific version of a resource found at a URL. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32` checksum of the object. + This checksum is only present if the object was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. + For more information, see [Checking object integrity in the Amazon S3 + User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum was uploaded with the object. + For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type, which determines how part-level checksums + are combined to create an object-level checksum for multipart objects. + You can use this header response to verify that the checksum type that + is received is the same checksum type that was specified in the `CreateMultipartUpload` + request. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + MissingMeta: + $ref: '#/components/schemas/MissingMeta' + description: '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.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID of the object. + + + This functionality is not supported for directory buckets.' + CacheControl: + $ref: '#/components/schemas/CacheControl' + description: Specifies caching behavior along the request/reply chain. + ContentDisposition: + $ref: '#/components/schemas/ContentDisposition' + description: Specifies presentational information for the object. + ContentEncoding: + $ref: '#/components/schemas/ContentEncoding' + description: 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. + ContentLanguage: + $ref: '#/components/schemas/ContentLanguage' + description: The language the content is in. + ContentRange: + $ref: '#/components/schemas/ContentRange' + description: The portion of the object returned in the response. + ContentType: + $ref: '#/components/schemas/ContentType' + description: A standard MIME type describing the format of the object data. + Expires: + $ref: '#/components/schemas/Expires' + description: The date and time at which the object is no longer cacheable. + WebsiteRedirectLocation: + $ref: '#/components/schemas/WebsiteRedirectLocation' + description: '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.' + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + Metadata: + $ref: '#/components/schemas/Metadata' + description: A map of metadata to store with the object in S3. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the object uses an S3 Bucket Key for server-side + encryption with Key Management Service (KMS) keys (SSE-KMS). + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: 'Provides storage class information of the object. Amazon S3 + returns this header for all objects except for S3 Standard storage class + objects. + + + **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` + (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` + (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ReplicationStatus: + $ref: '#/components/schemas/ReplicationStatus' + description: '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.' + PartsCount: + $ref: '#/components/schemas/PartsCount' + description: The count of parts this object has. This value is only returned + if you specify `partNumber` in your request and the object was uploaded + as a multipart upload. + TagCount: + $ref: '#/components/schemas/TagCount' + description: 'The number of tags, if any, on the object, when you have the + relevant permission to read object tags. + + + You can use [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) + to retrieve the tag set associated with an object. + + + This functionality is not supported for directory buckets.' + ObjectLockMode: + $ref: '#/components/schemas/ObjectLockMode' + description: 'The Object Lock mode that''s currently in place for this object. + + + This functionality is not supported for directory buckets.' + ObjectLockRetainUntilDate: + $ref: '#/components/schemas/ObjectLockRetainUntilDate' + description: 'The date and time when this object''s Object Lock will expire. + + + This functionality is not supported for directory buckets.' + ObjectLockLegalHoldStatus: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: '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.' + GetObjectRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + 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. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + IfMatch: + $ref: '#/components/schemas/IfMatch' + description: '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](https://tools.ietf.org/html/rfc7232).' + IfModifiedSince: + $ref: '#/components/schemas/IfModifiedSince' + description: '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](https://tools.ietf.org/html/rfc7232).' + IfNoneMatch: + $ref: '#/components/schemas/IfNoneMatch' + description: '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](https://tools.ietf.org/html/rfc7232).' + IfUnmodifiedSince: + $ref: '#/components/schemas/IfUnmodifiedSince' + description: '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](https://tools.ietf.org/html/rfc7232).' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Key of the object to get. + Range: + $ref: '#/components/schemas/Range' + description: 'Downloads the specified byte range of an object. For more + information about the HTTP Range header, see . + + + Amazon S3 doesn''t support retrieving multiple ranges of data per `GET` + request.' + ResponseCacheControl: + $ref: '#/components/schemas/ResponseCacheControl' + description: Sets the `Cache-Control` header of the response. + ResponseContentDisposition: + $ref: '#/components/schemas/ResponseContentDisposition' + description: Sets the `Content-Disposition` header of the response. + ResponseContentEncoding: + $ref: '#/components/schemas/ResponseContentEncoding' + description: Sets the `Content-Encoding` header of the response. + ResponseContentLanguage: + $ref: '#/components/schemas/ResponseContentLanguage' + description: Sets the `Content-Language` header of the response. + ResponseContentType: + $ref: '#/components/schemas/ResponseContentType' + description: Sets the `Content-Type` header of the response. + ResponseExpires: + $ref: '#/components/schemas/ResponseExpires' + description: Sets the `Expires` header of the response. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: "Version ID used to reference a specific version of the object.\n\ + \nBy default, the `GetObject` operation returns the current version of\ + \ an object. To return a different version, use the `versionId` subresource.\n\ + \n * 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.\n\ + \n * 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.\n\n * **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.\n\nFor more information about versioning, see [PutBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html)." + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: "Specifies the algorithm to use when decrypting the object\ + \ (for example, `AES256`).\n\nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\ + \n * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ + \nFor more information about SSE-C, see [Server-Side Encryption (Using\ + \ Customer-Provided Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ + \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported\ + \ for directory buckets." + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: "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.\n\nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\n\ + \ * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ + \nFor more information about SSE-C, see [Server-Side Encryption (Using\ + \ Customer-Provided Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ + \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported\ + \ for directory buckets." + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: "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.\n\nIf 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:\n\n * `x-amz-server-side-encryption-customer-algorithm`\n\n\ + \ * `x-amz-server-side-encryption-customer-key`\n\n * `x-amz-server-side-encryption-customer-key-MD5`\n\ + \nFor more information about SSE-C, see [Server-Side Encryption (Using\ + \ Customer-Provided Encryption Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)\ + \ in the _Amazon S3 User Guide_.\n\nThis functionality is not supported\ + \ for directory buckets." + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: Part number of the object being read. This is a positive integer + between 1 and 10,000. Effectively performs a 'ranged' GET request for + the part specified. Useful for downloading just a part of an object. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ChecksumMode: + $ref: '#/components/schemas/ChecksumMode' + description: To retrieve the checksum, this mode must be enabled. + required: + - Bucket + - Key + GetObjectResponseStatusCode: + type: integer + GetObjectRetentionOutput: + type: object + properties: + Retention: + $ref: '#/components/schemas/ObjectLockRetention' + description: The container element for an object's retention settings. + GetObjectRetentionRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket name containing the object whose retention settings + you want to retrieve. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key name for the object whose retention settings you want + to retrieve. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The version ID for the object whose retention settings you + want to retrieve. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + GetObjectTaggingOutput: + type: object + properties: + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The versionId of the object for which you got the tagging information. + TagSet: + $ref: '#/components/schemas/TagSet' + description: Contains the tag set. + required: + - TagSet + GetObjectTaggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket name containing the object for which to get the + tagging information. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which to get the tagging information. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The versionId of the object for which to get the tagging information. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + required: + - Bucket + - Key + GetObjectTorrentOutput: + type: object + properties: + Body: + $ref: '#/components/schemas/StreamingBlob' + description: A Bencoded dictionary as defined by the BitTorrent specification + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + GetObjectTorrentRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the object for which to get + the torrent files. + Key: + $ref: '#/components/schemas/ObjectKey' + description: The object key for which to get the information. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + GetPublicAccessBlockOutput: + type: object + properties: + PublicAccessBlockConfiguration: + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + description: The `PublicAccessBlock` configuration currently in effect for + this Amazon S3 bucket. + GetPublicAccessBlockRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose `PublicAccessBlock` + configuration you want to retrieve. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + GlacierJobParameters: + type: object + properties: + Tier: + $ref: '#/components/schemas/Tier' + description: Retrieval tier at which the restore will be processed. + required: + - Tier + description: Container for S3 Glacier job parameters. + Grant: + type: object + properties: + Grantee: + $ref: '#/components/schemas/Grantee' + description: The person being granted permissions. + Permission: + $ref: '#/components/schemas/Permission' + description: Specifies the permission given to the grantee. + description: Container for grant information. + GrantFullControl: + type: string + GrantRead: + type: string + GrantReadACP: + type: string + GrantWrite: + type: string + GrantWriteACP: + type: string + Grantee: + type: object + properties: + DisplayName: + $ref: '#/components/schemas/DisplayName' + description: '' + EmailAddress: + $ref: '#/components/schemas/EmailAddress' + description: '' + ID: + $ref: '#/components/schemas/ID' + description: The canonical user ID of the grantee. + URI: + $ref: '#/components/schemas/URI' + description: URI of the grantee group. + Type: + $ref: '#/components/schemas/Type' + description: Type of grantee + required: + - Type + description: Container for the person being granted permissions. + Grants: + type: array + items: + $ref: '#/components/schemas/Grant' + HeadBucketOutput: + type: object + properties: + BucketArn: + $ref: '#/components/schemas/S3RegionalOrS3ExpressBucketArnString' + description: 'The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely + identify Amazon Web Services resources across all of Amazon Web Services. + + + This parameter is only supported for S3 directory buckets. For more information, + see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).' + BucketLocationType: + $ref: '#/components/schemas/LocationType' + description: 'The type of location where the bucket is created. + + + This functionality is only supported by directory buckets.' + BucketLocationName: + $ref: '#/components/schemas/BucketLocationName' + description: 'The name of the location where the bucket will be created. + + + For directory buckets, the Zone ID of the Availability Zone or the Local + Zone where the bucket is created. An example Zone ID value for an Availability + Zone is `usw2-az1`. + + + This functionality is only supported by directory buckets.' + BucketRegion: + $ref: '#/components/schemas/Region' + description: The Region that the bucket is located. + AccessPointAlias: + $ref: '#/components/schemas/AccessPointAlias' + description: 'Indicates whether the bucket name used in the request is an + access point alias. + + + For directory buckets, the value of this field is `false`.' + HeadBucketRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + HeadObjectOutput: + type: object + properties: + DeleteMarker: + $ref: '#/components/schemas/DeleteMarker' + description: '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.' + AcceptRanges: + $ref: '#/components/schemas/AcceptRanges' + description: Indicates that a range of bytes was specified. + Expiration: + $ref: '#/components/schemas/Expiration' + description: 'If the object expiration is configured (see [ `PutBucketLifecycleConfiguration` + ](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)), + 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. + + + Object expiration information is not returned in directory buckets and + this header returns the value "`NotImplemented`" in all responses for + directory buckets.' + Restore: + $ref: '#/components/schemas/Restore' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) + 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations). + + + This functionality is not supported for directory buckets. Directory buckets + only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) + in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access + storage class) in Dedicated Local Zones.' + ArchiveStatus: + $ref: '#/components/schemas/ArchiveStatus' + description: 'The archive state of the head object. + + + This functionality is not supported for directory buckets.' + LastModified: + $ref: '#/components/schemas/LastModified' + description: Date and time when the object was last modified. + ContentLength: + $ref: '#/components/schemas/ContentLength' + description: Size of the body in bytes. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. + For more information, see [Checking object integrity in the Amazon S3 + User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type, which determines how part-level checksums + are combined to create an object-level checksum for multipart objects. + You can use this header response to verify that the checksum type that + is received is the same checksum type that was specified in `CreateMultipartUpload` + request. For more information, see [Checking object integrity in the Amazon + S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ETag: + $ref: '#/components/schemas/ETag' + description: An entity tag (ETag) is an opaque identifier assigned by a + web server to a specific version of a resource found at a URL. + MissingMeta: + $ref: '#/components/schemas/MissingMeta' + description: '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.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID of the object. + + + This functionality is not supported for directory buckets.' + CacheControl: + $ref: '#/components/schemas/CacheControl' + description: Specifies caching behavior along the request/reply chain. + ContentDisposition: + $ref: '#/components/schemas/ContentDisposition' + description: Specifies presentational information for the object. + ContentEncoding: + $ref: '#/components/schemas/ContentEncoding' + description: 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. + ContentLanguage: + $ref: '#/components/schemas/ContentLanguage' + description: The language the content is in. + ContentType: + $ref: '#/components/schemas/ContentType' + description: A standard MIME type describing the format of the object data. + ContentRange: + $ref: '#/components/schemas/ContentRange' + description: The portion of the object returned in the response for a `GET` + request. + Expires: + $ref: '#/components/schemas/Expires' + description: The date and time at which the object is no longer cacheable. + WebsiteRedirectLocation: + $ref: '#/components/schemas/WebsiteRedirectLocation' + description: '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.' + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + Metadata: + $ref: '#/components/schemas/Metadata' + description: A map of metadata to store with the object in S3. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the object uses an S3 Bucket Key for server-side + encryption with Key Management Service (KMS) keys (SSE-KMS). + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). + + + **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` + (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` + (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ReplicationStatus: + $ref: '#/components/schemas/ReplicationStatus' + description: "Amazon S3 can return this header if your request involves\ + \ a bucket that is either a source or a destination in a replication rule.\n\ + \nIn 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:\n\n * **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.\n\n\ + 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.\n\n * **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.\n\n * **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. \n\nFor more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).\n\ + \nThis functionality is not supported for directory buckets." + PartsCount: + $ref: '#/components/schemas/PartsCount' + description: The count of parts this object has. This value is only returned + if you specify `partNumber` in your request and the object was uploaded + as a multipart upload. + TagCount: + $ref: '#/components/schemas/TagCount' + description: 'The number of tags, if any, on the object, when you have the + relevant permission to read object tags. + + + You can use [GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) + to retrieve the tag set associated with an object. + + + This functionality is not supported for directory buckets.' + ObjectLockMode: + $ref: '#/components/schemas/ObjectLockMode' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + + + This functionality is not supported for directory buckets.' + ObjectLockRetainUntilDate: + $ref: '#/components/schemas/ObjectLockRetainUntilDate' + description: '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.' + ObjectLockLegalHoldStatus: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + + + This functionality is not supported for directory buckets.' + HeadObjectRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + IfMatch: + $ref: '#/components/schemas/IfMatch' + description: "Return the object only if its entity tag (ETag) is the same\ + \ as the one specified; otherwise, return a 412 (precondition failed)\ + \ error.\n\nIf both of the `If-Match` and `If-Unmodified-Since` headers\ + \ are present in the request as follows:\n\n * `If-Match` condition evaluates\ + \ to `true`, and;\n\n * `If-Unmodified-Since` condition evaluates to\ + \ `false`;\n\nThen Amazon S3 returns `200 OK` and the data requested.\n\ + \nFor more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." + IfModifiedSince: + $ref: '#/components/schemas/IfModifiedSince' + description: "Return the object only if it has been modified since the specified\ + \ time; otherwise, return a 304 (not modified) error.\n\nIf both of the\ + \ `If-None-Match` and `If-Modified-Since` headers are present in the request\ + \ as follows:\n\n * `If-None-Match` condition evaluates to `false`, and;\n\ + \n * `If-Modified-Since` condition evaluates to `true`;\n\nThen Amazon\ + \ S3 returns the `304 Not Modified` response code.\n\nFor more information\ + \ about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." + IfNoneMatch: + $ref: '#/components/schemas/IfNoneMatch' + description: "Return the object only if its entity tag (ETag) is different\ + \ from the one specified; otherwise, return a 304 (not modified) error.\n\ + \nIf both of the `If-None-Match` and `If-Modified-Since` headers are present\ + \ in the request as follows:\n\n * `If-None-Match` condition evaluates\ + \ to `false`, and;\n\n * `If-Modified-Since` condition evaluates to `true`;\n\ + \nThen Amazon S3 returns the `304 Not Modified` response code.\n\nFor\ + \ more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." + IfUnmodifiedSince: + $ref: '#/components/schemas/IfUnmodifiedSince' + description: "Return the object only if it has not been modified since the\ + \ specified time; otherwise, return a 412 (precondition failed) error.\n\ + \nIf both of the `If-Match` and `If-Unmodified-Since` headers are present\ + \ in the request as follows:\n\n * `If-Match` condition evaluates to\ + \ `true`, and;\n\n * `If-Unmodified-Since` condition evaluates to `false`;\n\ + \nThen Amazon S3 returns `200 OK` and the data requested.\n\nFor more\ + \ information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232)." + Key: + $ref: '#/components/schemas/ObjectKey' + description: The object key. + Range: + $ref: '#/components/schemas/Range' + description: HeadObject returns only the metadata for an object. If the + Range is satisfiable, only the `ContentLength` is affected in the response. + If the Range is not satisfiable, S3 returns a `416 - Requested Range Not + Satisfiable` error. + ResponseCacheControl: + $ref: '#/components/schemas/ResponseCacheControl' + description: Sets the `Cache-Control` header of the response. + ResponseContentDisposition: + $ref: '#/components/schemas/ResponseContentDisposition' + description: Sets the `Content-Disposition` header of the response. + ResponseContentEncoding: + $ref: '#/components/schemas/ResponseContentEncoding' + description: Sets the `Content-Encoding` header of the response. + ResponseContentLanguage: + $ref: '#/components/schemas/ResponseContentLanguage' + description: Sets the `Content-Language` header of the response. + ResponseContentType: + $ref: '#/components/schemas/ResponseContentType' + description: Sets the `Content-Type` header of the response. + ResponseExpires: + $ref: '#/components/schemas/ResponseExpires' + description: Sets the `Expires` header of the response. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: '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.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: 'Specifies the algorithm to use when encrypting the object + (for example, AES256). + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: Part number of the object being read. This is a positive integer + between 1 and 10,000. Effectively performs a 'ranged' HEAD request for + the part specified. Useful querying about the size of the part and the + number of parts in this object. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ChecksumMode: + $ref: '#/components/schemas/ChecksumMode' + description: 'To retrieve the checksum, this parameter must be enabled. + + + **General purpose buckets** \- If you enable checksum mode and the object + is uploaded with a [checksum](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html) + and encrypted with an Key Management Service (KMS) key, you must have + permission to use the `kms:Decrypt` action to retrieve the checksum. + + + **Directory buckets** \- If you enable `ChecksumMode` and the object is + encrypted with Amazon Web Services Key Management Service (Amazon Web + Services KMS), you must also have the `kms:GenerateDataKey` and `kms:Decrypt` + permissions in IAM identity-based policies and KMS key policies for the + KMS key to retrieve the checksum of the object.' + required: + - Bucket + - Key + HostName: + type: string + HttpErrorCodeReturnedEquals: + type: string + HttpRedirectCode: + type: string + ID: + type: string + IdempotencyParameterMismatch: + type: object + properties: {} + description: 'Parameters on this idempotent request are inconsistent with parameters + used in previous request(s). + + + For a list of error codes and more information on Amazon S3 errors, see [Error + codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList). + + + Idempotency ensures that an API request completes no more than one time. With + an idempotent request, if the original request completes successfully, any + subsequent retries complete successfully without performing any further actions.' + IfMatch: + type: string + IfMatchInitiatedTime: + type: string + format: date-time + IfMatchLastModifiedTime: + type: string + format: date-time + IfMatchSize: + type: integer + format: int64 + IfModifiedSince: + type: string + format: date-time + IfNoneMatch: + type: string + IfUnmodifiedSince: + type: string + format: date-time + IndexDocument: + type: object + properties: + Suffix: + $ref: '#/components/schemas/Suffix' + description: 'A suffix that is appended to a request that is for a directory + on the website endpoint. (For example, if the suffix is `index.html` and + you make a request to `samplebucket/images/`, the data that is returned + will be for the object with the key name `images/index.html`.) The suffix + must not be empty and must not include a slash character. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + required: + - Suffix + description: Container for the `Suffix` element. + Initiated: + type: string + format: date-time + Initiator: + type: object + properties: + ID: + $ref: '#/components/schemas/ID' + description: '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: + $ref: '#/components/schemas/DisplayName' + description: This functionality is not supported for directory buckets. + description: Container element that identifies who initiated the multipart upload. + InputSerialization: + type: object + properties: + CSV: + $ref: '#/components/schemas/CSVInput' + description: Describes the serialization of a CSV-encoded object. + CompressionType: + $ref: '#/components/schemas/CompressionType' + description: 'Specifies object''s compression format. Valid values: NONE, + GZIP, BZIP2. Default Value: NONE.' + JSON: + $ref: '#/components/schemas/JSONInput' + description: Specifies JSON as object's input serialization format. + Parquet: + $ref: '#/components/schemas/ParquetInput' + description: Specifies Parquet as object's input serialization format. + description: Describes the serialization format of the object. + IntelligentTieringAccessTier: + type: string + enum: + - ARCHIVE_ACCESS + - DEEP_ARCHIVE_ACCESS + IntelligentTieringAndOperator: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: An object key name prefix that identifies the subset of objects + to which the configuration applies. + Tags: + $ref: '#/components/schemas/TagSet' + description: All of these tags must exist in the object's tag set in order + for the configuration to apply. + description: A container for specifying S3 Intelligent-Tiering filters. The + filters determine the subset of objects to which the rule applies. + IntelligentTieringConfiguration: + type: object + properties: + Id: + $ref: '#/components/schemas/IntelligentTieringId' + description: The ID used to identify the S3 Intelligent-Tiering configuration. + Filter: + $ref: '#/components/schemas/IntelligentTieringFilter' + description: Specifies a bucket filter. The configuration only includes + objects that meet the filter's criteria. + Status: + $ref: '#/components/schemas/IntelligentTieringStatus' + description: Specifies the status of the configuration. + Tierings: + $ref: '#/components/schemas/TieringList' + description: Specifies the S3 Intelligent-Tiering storage class tier of + the configuration. + required: + - Id + - Status + - Tierings + description: 'Specifies the S3 Intelligent-Tiering configuration for an Amazon + S3 bucket. + + + For information about the S3 Intelligent-Tiering storage class, see [Storage + class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).' + IntelligentTieringConfigurationList: + type: array + items: + $ref: '#/components/schemas/IntelligentTieringConfiguration' + IntelligentTieringDays: + type: integer + IntelligentTieringFilter: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'An object key name prefix that identifies the subset of objects + to which the rule applies. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + Tag: + $ref: '#/components/schemas/Tag' + And: + $ref: '#/components/schemas/IntelligentTieringAndOperator' + description: A conjunction (logical AND) of predicates, which is used in + evaluating a metrics filter. The operator must have at least two predicates, + and an object must match all of the predicates in order for the filter + to apply. + description: The `Filter` is used to identify objects that the S3 Intelligent-Tiering + configuration applies to. + IntelligentTieringId: + type: string + IntelligentTieringStatus: + type: string + enum: + - Enabled + - Disabled + InvalidObjectState: + type: object + properties: + StorageClass: + $ref: '#/components/schemas/StorageClass' + AccessTier: + $ref: '#/components/schemas/IntelligentTieringAccessTier' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). + Otherwise, this operation returns an `InvalidObjectState` error. For information + about restoring archived objects, see [Restoring Archived Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) + in the _Amazon S3 User Guide_.' + InvalidRequest: + type: object + properties: {} + description: "You may receive this error in multiple cases. Depending on the\ + \ reason for the error, you may receive one of the messages below:\n\n *\ + \ Cannot specify both a write offset value and user-defined object metadata\ + \ for existing objects.\n\n * Checksum Type mismatch occurred, expected checksum\ + \ Type: sha1, actual checksum Type: crc32c.\n\n * Request body cannot be\ + \ empty when 'write offset' is specified." + InvalidWriteOffset: + type: object + properties: {} + description: The write offset value that you specified does not match the current + object size. + InventoryConfiguration: + type: object + properties: + Destination: + $ref: '#/components/schemas/InventoryDestination' + description: Contains information about where to publish the inventory results. + IsEnabled: + $ref: '#/components/schemas/IsEnabled' + description: Specifies whether the inventory is enabled or disabled. If + set to `True`, an inventory list is generated. If set to `False`, no inventory + list is generated. + Filter: + $ref: '#/components/schemas/InventoryFilter' + description: Specifies an inventory filter. The inventory only includes + objects that meet the filter's criteria. + Id: + $ref: '#/components/schemas/InventoryId' + description: The ID used to identify the inventory configuration. + IncludedObjectVersions: + $ref: '#/components/schemas/InventoryIncludedObjectVersions' + description: Object versions to include in the inventory list. If set to + `All`, the list includes all the object versions, which adds the version-related + fields `VersionId`, `IsLatest`, and `DeleteMarker` to the list. If set + to `Current`, the list does not contain these version-related fields. + OptionalFields: + $ref: '#/components/schemas/InventoryOptionalFields' + description: Contains the optional fields that are included in the inventory + results. + Schedule: + $ref: '#/components/schemas/InventorySchedule' + description: Specifies the schedule for generating inventory results. + required: + - Destination + - IsEnabled + - Id + - IncludedObjectVersions + - Schedule + description: Specifies the S3 Inventory configuration for an Amazon S3 bucket. + For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) + in the _Amazon S3 API Reference_. + InventoryConfigurationList: + type: array + items: + $ref: '#/components/schemas/InventoryConfiguration' + InventoryConfigurationState: + type: string + enum: + - ENABLED + - DISABLED + InventoryDestination: + type: object + properties: + S3BucketDestination: + $ref: '#/components/schemas/InventoryS3BucketDestination' + description: Contains the bucket name, file format, bucket owner (optional), + and prefix (optional) where inventory results are published. + required: + - S3BucketDestination + description: Specifies the S3 Inventory configuration for an Amazon S3 bucket. + InventoryEncryption: + type: object + properties: + SSES3: + $ref: '#/components/schemas/SSES3' + description: Specifies the use of SSE-S3 to encrypt delivered inventory + reports. + SSEKMS: + $ref: '#/components/schemas/SSEKMS' + description: Specifies the use of SSE-KMS to encrypt delivered inventory + reports. + description: Contains the type of server-side encryption used to encrypt the + S3 Inventory results. + InventoryFilter: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: The prefix that an object must have to be included in the inventory + results. + required: + - Prefix + description: Specifies an S3 Inventory filter. The inventory only includes objects + that meet the filter's criteria. + InventoryFormat: + type: string + enum: + - CSV + - ORC + - Parquet + InventoryFrequency: + type: string + enum: + - Daily + - Weekly + InventoryId: + type: string + InventoryIncludedObjectVersions: + type: string + enum: + - All + - Current + InventoryOptionalField: + type: string + enum: + - Size + - LastModifiedDate + - StorageClass + - ETag + - IsMultipartUploaded + - ReplicationStatus + - EncryptionStatus + - ObjectLockRetainUntilDate + - ObjectLockMode + - ObjectLockLegalHoldStatus + - IntelligentTieringAccessTier + - BucketKeyStatus + - ChecksumAlgorithm + - ObjectAccessControlList + - ObjectOwner + InventoryOptionalFields: + type: array + items: + $ref: '#/components/schemas/InventoryOptionalField' + InventoryS3BucketDestination: + type: object + properties: + AccountId: + $ref: '#/components/schemas/AccountId' + description: 'The account ID that owns the destination S3 bucket. If no + account ID is provided, the owner is not validated before exporting data. + + + Although this value is optional, we strongly recommend that you set it + to help prevent problems if the destination bucket ownership changes.' + Bucket: + $ref: '#/components/schemas/BucketName' + description: The Amazon Resource Name (ARN) of the bucket where inventory + results will be published. + Format: + $ref: '#/components/schemas/InventoryFormat' + description: Specifies the output format of the inventory results. + Prefix: + $ref: '#/components/schemas/Prefix' + description: The prefix that is prepended to all inventory results. + Encryption: + $ref: '#/components/schemas/InventoryEncryption' + description: Contains the type of server-side encryption used to encrypt + the inventory results. + required: + - Bucket + - Format + description: Contains the bucket name, file format, bucket owner (optional), + and prefix (optional) where S3 Inventory results are published. + InventorySchedule: + type: object + properties: + Frequency: + $ref: '#/components/schemas/InventoryFrequency' + description: Specifies how frequently inventory results are produced. + required: + - Frequency + description: Specifies the schedule for generating S3 Inventory results. + InventoryTableConfiguration: + type: object + properties: + ConfigurationState: + $ref: '#/components/schemas/InventoryConfigurationState' + description: The configuration state of the inventory table, indicating + whether the inventory table is enabled or disabled. + EncryptionConfiguration: + $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' + description: The encryption configuration for the inventory table. + required: + - ConfigurationState + description: The inventory table configuration for an S3 Metadata configuration. + InventoryTableConfigurationResult: + type: object + properties: + ConfigurationState: + $ref: '#/components/schemas/InventoryConfigurationState' + description: The configuration state of the inventory table, indicating + whether the inventory table is enabled or disabled. + TableStatus: + $ref: '#/components/schemas/MetadataTableStatus' + description: "The status of the inventory table. The status values are:\n\ + \n * `CREATING` \\- The inventory table is in the process of being created\ + \ in the specified Amazon Web Services managed table bucket.\n\n * `BACKFILLING`\ + \ \\- The inventory table is in the process of being backfilled. When\ + \ you enable the inventory table for your metadata configuration, the\ + \ table goes through a process known as backfilling, during which Amazon\ + \ S3 scans your general purpose bucket to retrieve the initial metadata\ + \ for all objects in the bucket. Depending on the number of objects in\ + \ your bucket, this process can take several hours. When the backfilling\ + \ process is finished, the status of your inventory table changes from\ + \ `BACKFILLING` to `ACTIVE`. After backfilling is completed, updates to\ + \ your objects are reflected in the inventory table within one hour.\n\ + \n * `ACTIVE` \\- The inventory table has been created successfully,\ + \ and records are being delivered to the table. \n\n * `FAILED` \\- Amazon\ + \ S3 is unable to create the inventory table, or Amazon S3 is unable to\ + \ deliver records." + Error: + $ref: '#/components/schemas/ErrorDetails' + TableName: + $ref: '#/components/schemas/S3TablesName' + description: The name of the inventory table. + TableArn: + $ref: '#/components/schemas/S3TablesArn' + description: The Amazon Resource Name (ARN) for the inventory table. + required: + - ConfigurationState + description: The inventory table configuration for an S3 Metadata configuration. + InventoryTableConfigurationUpdates: + type: object + properties: + ConfigurationState: + $ref: '#/components/schemas/InventoryConfigurationState' + description: The configuration state of the inventory table, indicating + whether the inventory table is enabled or disabled. + EncryptionConfiguration: + $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' + description: The encryption configuration for the inventory table. + required: + - ConfigurationState + description: The specified updates to the S3 Metadata inventory table configuration. + IsEnabled: + type: boolean + IsLatest: + type: boolean + IsPublic: + type: boolean + IsRestoreInProgress: + type: boolean + IsTruncated: + type: boolean + JSONInput: + type: object + properties: + Type: + $ref: '#/components/schemas/JSONType' + description: 'The type of JSON. Valid values: Document, Lines.' + description: Specifies JSON as object's input serialization format. + JSONOutput: + type: object + properties: + RecordDelimiter: + $ref: '#/components/schemas/RecordDelimiter' + description: The value used to separate individual records in the output. + If no value is specified, Amazon S3 uses a newline character ('\n'). + description: Specifies JSON as request's output serialization format. + JSONType: + type: string + enum: + - DOCUMENT + - LINES + JournalTableConfiguration: + type: object + properties: + RecordExpiration: + $ref: '#/components/schemas/RecordExpiration' + description: The journal table record expiration settings for the journal + table. + EncryptionConfiguration: + $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' + description: The encryption configuration for the journal table. + required: + - RecordExpiration + description: The journal table configuration for an S3 Metadata configuration. + JournalTableConfigurationResult: + type: object + properties: + TableStatus: + $ref: '#/components/schemas/MetadataTableStatus' + description: "The status of the journal table. The status values are:\n\n\ + \ * `CREATING` \\- The journal table is in the process of being created\ + \ in the specified table bucket.\n\n * `ACTIVE` \\- The journal table\ + \ has been created successfully, and records are being delivered to the\ + \ table. \n\n * `FAILED` \\- Amazon S3 is unable to create the journal\ + \ table, or Amazon S3 is unable to deliver records." + Error: + $ref: '#/components/schemas/ErrorDetails' + TableName: + $ref: '#/components/schemas/S3TablesName' + description: The name of the journal table. + TableArn: + $ref: '#/components/schemas/S3TablesArn' + description: The Amazon Resource Name (ARN) for the journal table. + RecordExpiration: + $ref: '#/components/schemas/RecordExpiration' + description: The journal table record expiration settings for the journal + table. + required: + - TableStatus + - TableName + - RecordExpiration + description: The journal table configuration for the S3 Metadata configuration. + JournalTableConfigurationUpdates: + type: object + properties: + RecordExpiration: + $ref: '#/components/schemas/RecordExpiration' + description: The journal table record expiration settings for the journal + table. + required: + - RecordExpiration + description: The specified updates to the S3 Metadata journal table configuration. + KMSContext: + type: string + KeyCount: + type: integer + KeyMarker: + type: string + KeyPrefixEquals: + type: string + KmsKeyArn: + type: string + LambdaFunctionArn: + type: string + LambdaFunctionConfiguration: + type: object + properties: + Id: + $ref: '#/components/schemas/NotificationId' + LambdaFunctionArn: + $ref: '#/components/schemas/LambdaFunctionArn' + description: The Amazon Resource Name (ARN) of the Lambda function that + Amazon S3 invokes when the specified event type occurs. + Events: + $ref: '#/components/schemas/EventList' + description: The Amazon S3 bucket event for which to invoke the Lambda function. + For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + in the _Amazon S3 User Guide_. + Filter: + $ref: '#/components/schemas/NotificationConfigurationFilter' + required: + - LambdaFunctionArn + - Events + description: A container for specifying the configuration for Lambda notifications. + LambdaFunctionConfigurationList: + type: array + items: + $ref: '#/components/schemas/LambdaFunctionConfiguration' + LastModified: + type: string + format: date-time + LastModifiedTime: + type: string + format: date-time + LifecycleExpiration: + type: object + properties: + Date: + $ref: '#/components/schemas/Date' + description: 'Indicates at what date the object is to be moved or deleted. + The date value must conform to the ISO 8601 format. The time is always + midnight UTC. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + Days: + $ref: '#/components/schemas/Days' + description: Indicates the lifetime, in days, of the objects that are subject + to the rule. The value must be a non-zero positive integer. + ExpiredObjectDeleteMarker: + $ref: '#/components/schemas/ExpiredObjectDeleteMarker' + description: 'Indicates whether Amazon S3 will remove a delete marker with + no noncurrent versions. If set to true, the delete marker will be expired; + if set to false the policy takes no action. This cannot be specified with + Days or Date in a Lifecycle Expiration Policy. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + description: 'Container for the expiration for the lifecycle of the object. + + + For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) + in the _Amazon S3 User Guide_.' + LifecycleRule: + type: object + properties: + Expiration: + $ref: '#/components/schemas/LifecycleExpiration' + description: Specifies the expiration for the lifecycle of the object in + the form of date, days and, whether the object has a delete marker. + ID: + $ref: '#/components/schemas/ID' + description: Unique identifier for the rule. The value cannot be longer + than 255 characters. + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'The general purpose bucket prefix that identifies one or more + objects to which the rule applies. We recommend using `Filter` instead + of `Prefix` for new PUTs. Previous configurations where a prefix is defined + will continue to operate as before. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + Filter: + $ref: '#/components/schemas/LifecycleRuleFilter' + description: 'The `Filter` is used to identify objects that a Lifecycle + Rule applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, + `ObjectSizeGreaterThan`, `ObjectSizeLessThan`, or `And` specified. `Filter` + is required if the `LifecycleRule` does not contain a `Prefix` element. + + + For more information about `Tag` filters, see [Adding filters to Lifecycle + rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-filters.html) + in the _Amazon S3 User Guide_. + + + `Tag` filters are not supported for directory buckets.' + Status: + $ref: '#/components/schemas/ExpirationStatus' + description: If 'Enabled', the rule is currently being applied. If 'Disabled', + the rule is not currently being applied. + Transitions: + $ref: '#/components/schemas/TransitionList' + description: 'Specifies when an Amazon S3 object transitions to a specified + storage class. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + NoncurrentVersionTransitions: + $ref: '#/components/schemas/NoncurrentVersionTransitionList' + description: 'Specifies the transition rule for the lifecycle rule that + describes when noncurrent objects transition to a specific storage class. + If your bucket is versioning-enabled (or versioning is suspended), you + can set this action to request that Amazon S3 transition noncurrent object + versions to a specific storage class at a set period in the object''s + lifetime. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + NoncurrentVersionExpiration: + $ref: '#/components/schemas/NoncurrentVersionExpiration' + AbortIncompleteMultipartUpload: + $ref: '#/components/schemas/AbortIncompleteMultipartUpload' + required: + - Status + description: 'A lifecycle rule for individual objects in an Amazon S3 bucket. + + + For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) + in the _Amazon S3 User Guide_.' + LifecycleRuleAndOperator: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: Prefix identifying one or more objects to which the rule applies. + Tags: + $ref: '#/components/schemas/TagSet' + description: All of these tags must exist in the object's tag set in order + for the rule to apply. + ObjectSizeGreaterThan: + $ref: '#/components/schemas/ObjectSizeGreaterThanBytes' + description: Minimum object size to which the rule applies. + ObjectSizeLessThan: + $ref: '#/components/schemas/ObjectSizeLessThanBytes' + description: Maximum object size to which the rule applies. + description: This is used in a Lifecycle Rule Filter to apply a logical AND + to two or more predicates. The Lifecycle Rule will apply to any object matching + all of the predicates configured inside the And operator. + LifecycleRuleFilter: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'Prefix identifying one or more objects to which the rule applies. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + Tag: + $ref: '#/components/schemas/Tag' + description: 'This tag must exist in the object''s tag set in order for + the rule to apply. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + ObjectSizeGreaterThan: + $ref: '#/components/schemas/ObjectSizeGreaterThanBytes' + description: Minimum object size to which the rule applies. + ObjectSizeLessThan: + $ref: '#/components/schemas/ObjectSizeLessThanBytes' + description: Maximum object size to which the rule applies. + And: + $ref: '#/components/schemas/LifecycleRuleAndOperator' + description: The `Filter` is used to identify objects that a Lifecycle Rule + applies to. A `Filter` can have exactly one of `Prefix`, `Tag`, `ObjectSizeGreaterThan`, + `ObjectSizeLessThan`, or `And` specified. If the `Filter` element is left + empty, the Lifecycle Rule applies to all objects in the bucket. + LifecycleRules: + type: array + items: + $ref: '#/components/schemas/LifecycleRule' + ListBucketAnalyticsConfigurationsOutput: + type: object + properties: + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Indicates whether the returned list of analytics configurations + is complete. A value of true indicates that the list is not complete and + the NextContinuationToken will be provided for a subsequent request. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The marker that is used as a starting point for this analytics + configuration list response. This value is present if it was sent in the + request. + NextContinuationToken: + $ref: '#/components/schemas/NextToken' + description: '`NextContinuationToken` is sent when `isTruncated` is true, + which indicates that there are more analytics configurations to list. + The next request must include this `NextContinuationToken`. The token + is obfuscated and is not a usable value.' + AnalyticsConfigurationList: + $ref: '#/components/schemas/AnalyticsConfigurationList' + description: The list of analytics configurations for a bucket. + ListBucketAnalyticsConfigurationsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket from which analytics configurations + are retrieved. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The `ContinuationToken` that represents a placeholder from + where this request should begin. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + ListBucketIntelligentTieringConfigurationsOutput: + type: object + properties: + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Indicates whether the returned list of analytics configurations + is complete. A value of `true` indicates that the list is not complete + and the `NextContinuationToken` will be provided for a subsequent request. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The `ContinuationToken` that represents a placeholder from + where this request should begin. + NextContinuationToken: + $ref: '#/components/schemas/NextToken' + description: The marker used to continue this inventory configuration listing. + Use the `NextContinuationToken` from this response to continue the listing + in a subsequent request. The continuation token is an opaque value that + Amazon S3 understands. + IntelligentTieringConfigurationList: + $ref: '#/components/schemas/IntelligentTieringConfigurationList' + description: The list of S3 Intelligent-Tiering configurations for a bucket. + ListBucketIntelligentTieringConfigurationsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose configuration you want + to modify or retrieve. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The `ContinuationToken` that represents a placeholder from + where this request should begin. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + ListBucketInventoryConfigurationsOutput: + type: object + properties: + ContinuationToken: + $ref: '#/components/schemas/Token' + description: If sent in the request, the marker that is used as a starting + point for this inventory configuration list response. + InventoryConfigurationList: + $ref: '#/components/schemas/InventoryConfigurationList' + description: The list of inventory configurations for a bucket. + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Tells whether the returned list of inventory configurations + is complete. A value of true indicates that the list is not complete and + the NextContinuationToken is provided for a subsequent request. + NextContinuationToken: + $ref: '#/components/schemas/NextToken' + description: The marker used to continue this inventory configuration listing. + Use the `NextContinuationToken` from this response to continue the listing + in a subsequent request. The continuation token is an opaque value that + Amazon S3 understands. + ListBucketInventoryConfigurationsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the inventory configurations + to retrieve. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The marker used to continue an inventory configuration listing + that has been truncated. Use the `NextContinuationToken` from a previously + truncated list response to continue the listing. The continuation token + is an opaque value that Amazon S3 understands. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + ListBucketMetricsConfigurationsOutput: + type: object + properties: + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Indicates whether the returned list of metrics configurations + is complete. A value of true indicates that the list is not complete and + the NextContinuationToken will be provided for a subsequent request. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The marker that is used as a starting point for this metrics + configuration list response. This value is present if it was sent in the + request. + NextContinuationToken: + $ref: '#/components/schemas/NextToken' + description: The marker used to continue a metrics configuration listing + that has been truncated. Use the `NextContinuationToken` from a previously + truncated list response to continue the listing. The continuation token + is an opaque value that Amazon S3 understands. + MetricsConfigurationList: + $ref: '#/components/schemas/MetricsConfigurationList' + description: The list of metrics configurations for a bucket. + ListBucketMetricsConfigurationsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket containing the metrics configurations + to retrieve. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: The marker that is used to continue a metrics configuration + listing that has been truncated. Use the `NextContinuationToken` from + a previously truncated list response to continue the listing. The continuation + token is an opaque value that Amazon S3 understands. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + ListBucketsOutput: + type: object + properties: + Buckets: + type: array + items: + allOf: + - $ref: "#/components/schemas/Bucket" + - xml: + name: Bucket + Owner: + $ref: '#/components/schemas/Owner' + description: The owner of the buckets listed. + ContinuationToken: + $ref: '#/components/schemas/NextToken' + description: '`ContinuationToken` is included in the response when there + are more buckets that can be listed with pagination. The next `ListBuckets` + request to Amazon S3 can be continued with this `ContinuationToken`. `ContinuationToken` + is obfuscated and is not a real bucket.' + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'If `Prefix` was sent with the request, it is included in the + response. + + + All bucket names in the response begin with the specified bucket name + prefix.' + ListBucketsRequest: + type: object + properties: + MaxBuckets: + $ref: '#/components/schemas/MaxBuckets' + description: 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. + ContinuationToken: + $ref: '#/components/schemas/Token' + description: '`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. + + + Length Constraints: Minimum length of 0. Maximum length of 1024. + + + Required: No. + + + If you specify the `bucket-region`, `prefix`, or `continuation-token` + query parameters without using `max-buckets` to set the maximum number + of buckets returned in the response, Amazon S3 applies a default page + size of 10,000 and provides a continuation token if there are more buckets.' + Prefix: + $ref: '#/components/schemas/Prefix' + description: Limits the response to bucket names that begin with the specified + bucket name prefix. + BucketRegion: + $ref: '#/components/schemas/BucketRegion' + description: 'Limits the response to buckets that are located in the specified + Amazon Web Services Region. The Amazon Web Services Region must be expressed + according to the Amazon Web Services Region code, such as `us-west-2` + for the US West (Oregon) Region. For a list of the valid values for all + of the Amazon Web Services Regions, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). + + + Requests made to a Regional endpoint that is different from the `bucket-region` + parameter are not supported. For example, if you want to limit the response + to your buckets in Region `us-west-2`, the request must be made to an + endpoint in Region `us-west-2`.' + ListDirectoryBucketsOutput: + type: object + properties: + Buckets: + $ref: '#/components/schemas/Buckets' + description: The list of buckets owned by the requester. + ContinuationToken: + $ref: '#/components/schemas/DirectoryBucketToken' + description: 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: object + properties: + ContinuationToken: + $ref: '#/components/schemas/DirectoryBucketToken' + description: '`ContinuationToken` indicates to Amazon S3 that the list is + being continued on buckets in this account with a token. `ContinuationToken` + is obfuscated and is not a real bucket name. You can use this `ContinuationToken` + for the pagination of the list results.' + MaxDirectoryBuckets: + $ref: '#/components/schemas/MaxDirectoryBuckets' + description: 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. + ListMultipartUploadsOutput: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 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. + KeyMarker: + $ref: '#/components/schemas/KeyMarker' + description: The key at or after which the listing began. + UploadIdMarker: + $ref: '#/components/schemas/UploadIdMarker' + description: '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.' + NextKeyMarker: + $ref: '#/components/schemas/NextKeyMarker' + description: When a list is truncated, this element specifies the value + that should be used for the key-marker request parameter in a subsequent + request. + Prefix: + $ref: '#/components/schemas/Prefix' + description: '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: + $ref: '#/components/schemas/Delimiter' + description: '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: + $ref: '#/components/schemas/NextUploadIdMarker' + description: '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: + $ref: '#/components/schemas/MaxUploads' + description: Maximum number of multipart uploads that could have been included + in the response. + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Indicates whether the returned list of multipart uploads is + truncated. A value of true indicates that the list was truncated. The + list can be truncated if the number of multipart uploads exceeds the limit + allowed or specified by max uploads. + Uploads: + $ref: '#/components/schemas/MultipartUploadList' + description: Container for elements related to a particular multipart upload. + A response can contain zero or more `Upload` elements. + CommonPrefixes: + $ref: '#/components/schemas/CommonPrefixList' + description: '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: + $ref: '#/components/schemas/EncodingType' + description: 'Encoding type used by Amazon S3 to encode object keys in the + response. + + + If you specify the `encoding-type` request parameter, Amazon S3 includes + this element in the response, and returns encoded key name values in the + following response elements: + + + `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ListMultipartUploadsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: '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. + + + `CommonPrefixes` is filtered out from results if it is not lexicographically + greater than the key-marker. + + + **Directory buckets** \- For directory buckets, `/` is the only supported + delimiter.' + EncodingType: + $ref: '#/components/schemas/EncodingType' + KeyMarker: + $ref: '#/components/schemas/KeyMarker' + description: "Specifies the multipart upload after which listing should\ + \ begin.\n\n * **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.\n\nIf `upload-id-marker` is not specified, only the keys lexicographically\ + \ greater than the specified `key-marker` will be included in the list.\n\ + \nIf `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`.\n\n * **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. \n\nIn the `ListMultipartUploads`\ + \ response, the multipart uploads aren't sorted lexicographically based\ + \ on the object keys." + MaxUploads: + $ref: '#/components/schemas/MaxUploads' + description: Sets the maximum number of multipart uploads, from 1 to 1,000, + to return in the response body. 1,000 is the maximum number of uploads + that can be returned in a response. + Prefix: + $ref: '#/components/schemas/Prefix' + description: '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.' + UploadIdMarker: + $ref: '#/components/schemas/UploadIdMarker' + description: '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.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + required: + - Bucket + ListObjectVersionsOutput: + type: object + properties: + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: A flag that indicates whether Amazon S3 returned all of the + results that satisfied the search criteria. If your results were truncated, + you can make a follow-up paginated request by using the `NextKeyMarker` + and `NextVersionIdMarker` response parameters as a starting place in another + request to return the rest of the results. + KeyMarker: + $ref: '#/components/schemas/KeyMarker' + description: Marks the last key returned in a truncated response. + VersionIdMarker: + $ref: '#/components/schemas/VersionIdMarker' + description: Marks the last version of the key returned in a truncated response. + NextKeyMarker: + $ref: '#/components/schemas/NextKeyMarker' + description: When the number of responses exceeds the value of `MaxKeys`, + `NextKeyMarker` specifies the first key not returned that satisfies the + search criteria. Use this value for the key-marker request parameter in + a subsequent request. + NextVersionIdMarker: + $ref: '#/components/schemas/NextVersionIdMarker' + description: When the number of responses exceeds the value of `MaxKeys`, + `NextVersionIdMarker` specifies the first object version not returned + that satisfies the search criteria. Use this value for the `version-id-marker` + request parameter in a subsequent request. + Versions: + $ref: '#/components/schemas/ObjectVersionList' + description: Container for version information. + DeleteMarkers: + $ref: '#/components/schemas/DeleteMarkers' + description: Container for an object that is a delete marker. To learn more + about delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). + Name: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + Prefix: + $ref: '#/components/schemas/Prefix' + description: Selects objects that start with the value supplied by this + parameter. + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: The delimiter grouping the included keys. A delimiter is a + character that you specify to group keys. All keys that contain the same + string between the prefix and the first occurrence of the delimiter are + grouped under a single result element in `CommonPrefixes`. These groups + are counted as one result against the `max-keys` limitation. These keys + are not returned elsewhere in the response. + MaxKeys: + $ref: '#/components/schemas/MaxKeys' + description: Specifies the maximum number of objects to return. + CommonPrefixes: + $ref: '#/components/schemas/CommonPrefixList' + description: All of the keys rolled up into a common prefix count as a single + return when calculating the number of returns. + EncodingType: + $ref: '#/components/schemas/EncodingType' + description: 'Encoding type used by Amazon S3 to encode object key names + in the XML response. + + + If you specify the `encoding-type` request parameter, Amazon S3 includes + this element in the response, and returns encoded key name values in the + following response elements: + + + `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ListObjectVersionsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name that contains the objects. + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: 'A delimiter is a character that you specify to group keys. + All keys that contain the same string between the `prefix` and the first + occurrence of the delimiter are grouped under a single result element + in `CommonPrefixes`. These groups are counted as one result against the + `max-keys` limitation. These keys are not returned elsewhere in the response. + + + `CommonPrefixes` is filtered out from results if it is not lexicographically + greater than the key-marker.' + EncodingType: + $ref: '#/components/schemas/EncodingType' + KeyMarker: + $ref: '#/components/schemas/KeyMarker' + description: Specifies the key to start with when listing objects in a bucket. + MaxKeys: + $ref: '#/components/schemas/MaxKeys' + description: Sets the maximum number of keys returned in the response. By + default, the action returns up to 1,000 key names. The response might + contain fewer keys but will never contain more. If additional keys satisfy + the search criteria, but were not returned because `max-keys` was exceeded, + the response contains `true`. To return the additional keys, see `key-marker` + and `version-id-marker`. + Prefix: + $ref: '#/components/schemas/Prefix' + description: Use this parameter to select only those keys that begin with + the specified prefix. You can use prefixes to separate a bucket into different + groupings 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.) You can use `prefix` + with `delimiter` to roll up numerous objects into a single result under + `CommonPrefixes`. + VersionIdMarker: + $ref: '#/components/schemas/VersionIdMarker' + description: Specifies the object version you want to start listing from. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + OptionalObjectAttributes: + $ref: '#/components/schemas/OptionalObjectAttributesList' + description: Specifies the optional fields that you want returned in the + response. Fields that you do not specify are not returned. + required: + - Bucket + ListObjectsOutput: + type: object + properties: + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: A flag that indicates whether Amazon S3 returned all of the + results that satisfied the search criteria. + Marker: + $ref: '#/components/schemas/Marker' + description: Indicates where in the bucket listing begins. Marker is included + in the response if it was sent with the request. + NextMarker: + $ref: '#/components/schemas/NextMarker' + description: 'When the response is truncated (the `IsTruncated` element + value in the response is `true`), you can use the key name in this field + as the `marker` parameter in the subsequent request to get the next set + of objects. Amazon S3 lists objects in alphabetical order. + + + This element is returned only if you have the `delimiter` request parameter + specified. If the response does not include the `NextMarker` element and + it is truncated, you can use the value of the last `Key` element in the + response as the `marker` parameter in the subsequent request to get the + next set of object keys.' + Contents: + $ref: '#/components/schemas/ObjectList' + description: Metadata about each object returned. + Name: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + Prefix: + $ref: '#/components/schemas/Prefix' + description: Keys that begin with the indicated prefix. + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: 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. + MaxKeys: + $ref: '#/components/schemas/MaxKeys' + description: The maximum number of keys returned in the response body. + CommonPrefixes: + $ref: '#/components/schemas/CommonPrefixList' + description: 'All of the keys (up to 1,000) rolled up in 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 the 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.' + EncodingType: + $ref: '#/components/schemas/EncodingType' + description: 'Encoding type used by Amazon S3 to encode the [object keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html) + in the response. Responses are encoded only in UTF-8. An object key can + contain any Unicode character. However, the XML 1.0 parser can''t parse + certain characters, such as characters with an ASCII value from 0 to 10. + For characters that aren''t supported in XML 1.0, you can add this parameter + to request that Amazon S3 encode the keys in the response. For more information + about characters to avoid in object key names, see [Object key naming + guidelines](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines). + + + When using the URL encoding type, non-ASCII characters that are used in + an object''s key name will be percent-encoded according to UTF-8 code + values. For example, the object `test_file(3).png` will appear as `test_file%283%29.png`.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ListObjectsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: 'A delimiter is a character that you use to group keys. + + + `CommonPrefixes` is filtered out from results if it is not lexicographically + greater than the key-marker.' + EncodingType: + $ref: '#/components/schemas/EncodingType' + Marker: + $ref: '#/components/schemas/Marker' + description: Marker is where you want Amazon S3 to start listing from. Amazon + S3 starts listing after this specified key. Marker can be any key in the + bucket. + MaxKeys: + $ref: '#/components/schemas/MaxKeys' + description: Sets the maximum number of keys returned in the response. By + default, the action returns up to 1,000 key names. The response might + contain fewer keys but will never contain more. + Prefix: + $ref: '#/components/schemas/Prefix' + description: Limits the response to keys that begin with the specified prefix. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + description: Confirms that the requester knows that she or he will be charged + for the list objects request. Bucket owners need not specify this parameter + in their requests. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + OptionalObjectAttributes: + $ref: '#/components/schemas/OptionalObjectAttributesList' + description: Specifies the optional fields that you want returned in the + response. Fields that you do not specify are not returned. + required: + - Bucket + ListObjectsV2Output: + type: object + properties: + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Set to `false` if all of the results were returned. Set to + `true` if more keys are available to return. If the number of results + exceeds that specified by `MaxKeys`, all of the results might not be returned. + Contents: + $ref: '#/components/schemas/ObjectList' + description: Metadata about each object returned. + Name: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'Keys that begin with the indicated prefix. + + + **Directory buckets** \- For directory buckets, only prefixes that end + in a delimiter (`/`) are supported.' + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: '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: + $ref: '#/components/schemas/MaxKeys' + description: Sets the maximum number of keys returned in the response. By + default, the action returns up to 1,000 key names. The response might + contain fewer keys but will never contain more. + CommonPrefixes: + $ref: '#/components/schemas/CommonPrefixList' + description: "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.\n\nA response\ + \ can contain `CommonPrefixes` only if you specify a delimiter.\n\n`CommonPrefixes`\ + \ contains all (if there are any) keys between `Prefix` and the next occurrence\ + \ of the string specified by a delimiter.\n\n`CommonPrefixes` lists keys\ + \ that act like subdirectories in the directory specified by `Prefix`.\n\ + \nFor 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.\n\n * **Directory buckets**\ + \ \\- For directory buckets, only prefixes that end in a delimiter (`/`)\ + \ are supported.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\ + \ in the _Amazon S3 User Guide_." + EncodingType: + $ref: '#/components/schemas/EncodingType' + description: 'Encoding type used by Amazon S3 to encode object key names + in the XML response. + + + If you specify the `encoding-type` request parameter, Amazon S3 includes + this element in the response, and returns encoded key name values in the + following response elements: + + + `Delimiter, Prefix, Key,` and `StartAfter`.' + KeyCount: + $ref: '#/components/schemas/KeyCount' + description: '`KeyCount` is the number of keys returned with this request. + `KeyCount` will always be less than or equal to the `MaxKeys` field. For + example, if you ask for 50 keys, your result will include 50 keys or fewer.' + ContinuationToken: + $ref: '#/components/schemas/Token' + description: 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. + NextContinuationToken: + $ref: '#/components/schemas/NextToken' + description: '`NextContinuationToken` is sent when `isTruncated` is true, + which means there are more keys in the bucket that can be listed. The + next list requests to Amazon S3 can be continued with this `NextContinuationToken`. + `NextContinuationToken` is obfuscated and is not a real key' + StartAfter: + $ref: '#/components/schemas/StartAfter' + description: 'If StartAfter was sent with the request, it is included in + the response. + + + This functionality is not supported for directory buckets.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ListObjectsV2Request: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '**Directory buckets** \- When you use this operation with + a directory bucket, you must use virtual-hosted-style requests in the + format ` _Bucket-name_.s3express-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Delimiter: + $ref: '#/components/schemas/Delimiter' + description: "A delimiter is a character that you use to group keys.\n\n\ + `CommonPrefixes` is filtered out from results if it is not lexicographically\ + \ greater than the `StartAfter` value.\n\n * **Directory buckets** \\\ + - For directory buckets, `/` is the only supported delimiter.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\ + \ in the _Amazon S3 User Guide_." + EncodingType: + $ref: '#/components/schemas/EncodingType' + description: 'Encoding type used by Amazon S3 to encode the [object keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html) + in the response. Responses are encoded only in UTF-8. An object key can + contain any Unicode character. However, the XML 1.0 parser can''t parse + certain characters, such as characters with an ASCII value from 0 to 10. + For characters that aren''t supported in XML 1.0, you can add this parameter + to request that Amazon S3 encode the keys in the response. For more information + about characters to avoid in object key names, see [Object key naming + guidelines](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines). + + + When using the URL encoding type, non-ASCII characters that are used in + an object''s key name will be percent-encoded according to UTF-8 code + values. For example, the object `test_file(3).png` will appear as `test_file%283%29.png`.' + MaxKeys: + $ref: '#/components/schemas/MaxKeys' + description: Sets the maximum number of keys returned in the response. By + default, the action returns up to 1,000 key names. The response might + contain fewer keys but will never contain more. + Prefix: + $ref: '#/components/schemas/Prefix' + description: '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.' + ContinuationToken: + $ref: '#/components/schemas/Token' + description: '`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.' + FetchOwner: + $ref: '#/components/schemas/FetchOwner' + description: '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.' + StartAfter: + $ref: '#/components/schemas/StartAfter' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + description: '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.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + OptionalObjectAttributes: + $ref: '#/components/schemas/OptionalObjectAttributesList' + description: '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.' + required: + - Bucket + ListPartsOutput: + type: object + properties: + AbortDate: + $ref: '#/components/schemas/AbortDate' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). + + + 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.' + AbortRuleId: + $ref: '#/components/schemas/AbortRuleId' + description: '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.' + Bucket: + $ref: '#/components/schemas/BucketName' + description: 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. + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload was initiated. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: Upload ID identifying the multipart upload whose parts are + being listed. + PartNumberMarker: + $ref: '#/components/schemas/PartNumberMarker' + description: Specifies the part after which listing should begin. Only parts + with higher part numbers will be listed. + NextPartNumberMarker: + $ref: '#/components/schemas/NextPartNumberMarker' + description: When a list is truncated, this element specifies the last part + in the list, as well as the value to use for the `part-number-marker` + request parameter in a subsequent request. + MaxParts: + $ref: '#/components/schemas/MaxParts' + description: Maximum number of parts that were allowed in the response. + IsTruncated: + $ref: '#/components/schemas/IsTruncated' + description: Indicates whether the returned list of parts is truncated. + A true value indicates that the list was truncated. A list can be truncated + if the number of parts exceeds the limit returned in the MaxParts element. + Parts: + $ref: '#/components/schemas/Parts' + description: Container for elements related to a particular part. A response + can contain zero or more `Part` elements. + Initiator: + $ref: '#/components/schemas/Initiator' + description: Container element that identifies who initiated the multipart + upload. If the initiator is an Amazon Web Services account, this element + provides the same information as the `Owner` element. If the initiator + is an IAM User, this element provides the user ARN. + Owner: + $ref: '#/components/schemas/Owner' + description: '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. + + + **Directory buckets** \- The bucket owner is returned as the object owner + for all the parts.' + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: 'The class of storage used to store the uploaded object. + + + **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` + (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` + (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The algorithm that was used to create a checksum of the object. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type, which determines how part-level checksums + are combined to create an object-level checksum for multipart objects. + You can use this header response to verify that the checksum type that + is received is the same checksum type that was specified in `CreateMultipartUpload` + request. For more information, see [Checking object integrity in the Amazon + S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ListPartsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload was initiated. + MaxParts: + $ref: '#/components/schemas/MaxParts' + description: Sets the maximum number of parts to return. + PartNumberMarker: + $ref: '#/components/schemas/PartNumberMarker' + description: Specifies the part after which listing should begin. Only parts + with higher part numbers will be listed. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: Upload ID identifying the multipart upload whose parts are + being listed. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + required: + - Bucket + - Key + - UploadId + Location: + type: string + LocationInfo: + type: object + properties: + Type: + $ref: '#/components/schemas/LocationType' + description: The type of location where the bucket will be created. + Name: + $ref: '#/components/schemas/LocationNameAsString' + description: 'The name of the location where the bucket will be created. + + + For directory buckets, the name of the location is the Zone ID of the + Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. + An example AZ ID value is `usw2-az1`.' + description: 'Specifies the location where the bucket will be created. + + + For directory buckets, the location type is Availability Zone or Local Zone. + For more information about directory buckets, see [Working with directory + buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) + 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 + - LocalZone + LoggingEnabled: + type: object + properties: + TargetBucket: + $ref: '#/components/schemas/TargetBucket' + description: Specifies the bucket where you want Amazon S3 to store server + access logs. You can have your logs delivered to any bucket that you own, + including the same bucket that is being logged. You can also configure + multiple buckets to deliver their logs to the same target bucket. In this + case, you should choose a different `TargetPrefix` for each source bucket + so that the delivered log files can be distinguished by key. + TargetGrants: + $ref: '#/components/schemas/TargetGrants' + description: 'Container for granting information. + + + Buckets that use the bucket owner enforced setting for Object Ownership + don''t support target grants. For more information, see [Permissions for + server access log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) + in the _Amazon S3 User Guide_.' + TargetPrefix: + $ref: '#/components/schemas/TargetPrefix' + description: A prefix for all log object keys. If you store log files from + multiple Amazon S3 buckets in a single bucket, you can use a prefix to + distinguish which log files came from which bucket. + TargetObjectKeyFormat: + $ref: '#/components/schemas/TargetObjectKeyFormat' + description: Amazon S3 key format for log objects. + required: + - TargetBucket + - TargetPrefix + description: Describes where logs are stored and the prefix that Amazon S3 assigns + to all log object keys for a bucket. For more information, see [PUT Bucket + logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) + in the _Amazon S3 API Reference_. + MFA: + type: string + MFADelete: + type: string + enum: + - Enabled + - Disabled + MFADeleteStatus: + type: string + enum: + - Enabled + - Disabled + Marker: + type: string + MaxAgeSeconds: + type: integer + MaxBuckets: + type: integer + minimum: 1 + maximum: 10000 + MaxDirectoryBuckets: + type: integer + minimum: 0 + maximum: 1000 + MaxKeys: + type: integer + MaxParts: + type: integer + MaxUploads: + type: integer + Message: + type: string + Metadata: + type: object + additionalProperties: + $ref: '#/components/schemas/metadatavalue' + MetadataConfiguration: + type: object + properties: + JournalTableConfiguration: + $ref: '#/components/schemas/JournalTableConfiguration' + description: The journal table configuration for a metadata configuration. + InventoryTableConfiguration: + $ref: '#/components/schemas/InventoryTableConfiguration' + description: The inventory table configuration for a metadata configuration. + required: + - JournalTableConfiguration + description: The S3 Metadata configuration for a general purpose bucket. + MetadataConfigurationResult: + type: object + properties: + DestinationResult: + $ref: '#/components/schemas/DestinationResult' + description: The destination settings for a metadata configuration. + JournalTableConfigurationResult: + $ref: '#/components/schemas/JournalTableConfigurationResult' + description: The journal table configuration for a metadata configuration. + InventoryTableConfigurationResult: + $ref: '#/components/schemas/InventoryTableConfigurationResult' + description: The inventory table configuration for a metadata configuration. + required: + - DestinationResult + description: The S3 Metadata configuration for a general purpose bucket. + MetadataDirective: + type: string + enum: + - COPY + - REPLACE + MetadataEntry: + type: object + properties: + Name: + $ref: '#/components/schemas/MetadataKey' + description: Name of the object. + Value: + $ref: '#/components/schemas/MetadataValue' + description: Value of the object. + description: A metadata key-value pair to store with an object. + MetadataKey: + type: string + MetadataTableConfiguration: + type: object + properties: + S3TablesDestination: + $ref: '#/components/schemas/S3TablesDestination' + description: The destination information for the metadata table configuration. + The destination table bucket must be in the same Region and Amazon Web + Services account as the general purpose bucket. The specified metadata + table name must be unique within the `aws_s3_metadata` namespace in the + destination table bucket. + required: + - S3TablesDestination + description: 'The V1 S3 Metadata configuration for a general purpose bucket. + + + If you created your S3 Metadata configuration before July 15, 2025, we recommend + that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) + so that you can expire journal table records and create a live inventory table.' + MetadataTableConfigurationResult: + type: object + properties: + S3TablesDestinationResult: + $ref: '#/components/schemas/S3TablesDestinationResult' + description: The destination information for the metadata table configuration. + The destination table bucket must be in the same Region and Amazon Web + Services account as the general purpose bucket. The specified metadata + table name must be unique within the `aws_s3_metadata` namespace in the + destination table bucket. + required: + - S3TablesDestinationResult + description: 'The V1 S3 Metadata configuration for a general purpose bucket. + The destination table bucket must be in the same Region and Amazon Web Services + account as the general purpose bucket. The specified metadata table name must + be unique within the `aws_s3_metadata` namespace in the destination table + bucket. + + + If you created your S3 Metadata configuration before July 15, 2025, we recommend + that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) + so that you can expire journal table records and create a live inventory table.' + MetadataTableEncryptionConfiguration: + type: object + properties: + SseAlgorithm: + $ref: '#/components/schemas/TableSseAlgorithm' + description: The encryption type specified for a metadata table. To specify + server-side encryption with Key Management Service (KMS) keys (SSE-KMS), + use the `aws:kms` value. To specify server-side encryption with Amazon + S3 managed keys (SSE-S3), use the `AES256` value. + KmsKeyArn: + $ref: '#/components/schemas/KmsKeyArn' + description: If server-side encryption with Key Management Service (KMS) + keys (SSE-KMS) is specified, you must also specify the KMS key Amazon + Resource Name (ARN). You must specify a customer-managed KMS key that's + located in the same Region as the general purpose bucket that corresponds + to the metadata table configuration. + required: + - SseAlgorithm + description: The encryption settings for an S3 Metadata journal table or inventory + table configuration. + MetadataTableStatus: + type: string + MetadataValue: + type: string + Metrics: + type: object + properties: + Status: + $ref: '#/components/schemas/MetricsStatus' + description: Specifies whether the replication metrics are enabled. + EventThreshold: + $ref: '#/components/schemas/ReplicationTimeValue' + description: A container specifying the time threshold for emitting the + `s3:Replication:OperationMissedThreshold` event. + required: + - Status + description: A container specifying replication metrics-related settings enabling + replication metrics and events. + MetricsAndOperator: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: The prefix used when evaluating an AND predicate. + Tags: + $ref: '#/components/schemas/TagSet' + description: The list of tags used when evaluating an AND predicate. + AccessPointArn: + $ref: '#/components/schemas/AccessPointArn' + description: The access point ARN used when evaluating an `AND` predicate. + description: A conjunction (logical AND) of predicates, which is used in evaluating + a metrics filter. The operator must have at least two predicates, and an object + must match all of the predicates in order for the filter to apply. + MetricsConfiguration: + type: object + properties: + Id: + $ref: '#/components/schemas/MetricsId' + description: The ID used to identify the metrics configuration. The ID has + a 64 character limit and can only contain letters, numbers, periods, dashes, + and underscores. + Filter: + $ref: '#/components/schemas/MetricsFilter' + description: Specifies a metrics configuration filter. The metrics configuration + will only include objects that meet the filter's criteria. A filter must + be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). + required: + - Id + description: Specifies a metrics configuration for the CloudWatch request metrics + (specified by the metrics configuration ID) from an Amazon S3 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. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). + MetricsConfigurationList: + type: array + items: + $ref: '#/components/schemas/MetricsConfiguration' + MetricsFilter: + allOf: + - $ref: '#/components/schemas/Prefix' + description: |- + The prefix used when evaluating a metrics filter. + - $ref: '#/components/schemas/Tag' + description: |- + The tag used when evaluating a metrics filter. + - $ref: '#/components/schemas/AccessPointArn' + description: |- + The access point ARN used when evaluating a metrics filter. + - $ref: '#/components/schemas/MetricsAndOperator' + description: |- + A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply. + description: |- + Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html). + MetricsId: + type: string + MetricsStatus: + type: string + enum: + - Enabled + - Disabled + Minutes: + type: integer + MissingMeta: + type: integer + MpuObjectSize: + type: integer + format: int64 + MultipartUpload: + type: object + properties: + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: Upload ID that identifies the multipart upload. + Key: + $ref: '#/components/schemas/ObjectKey' + description: Key of the object for which the multipart upload was initiated. + Initiated: + $ref: '#/components/schemas/Initiated' + description: Date and time at which the multipart upload was initiated. + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: 'The class of storage used to store the object. + + + **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` + (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` + (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' + Owner: + $ref: '#/components/schemas/Owner' + description: '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: + $ref: '#/components/schemas/Initiator' + description: Identifies who initiated the multipart upload. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The algorithm that was used to create a checksum of the object. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type that is used to calculate the object’s checksum + value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + description: Container for the `MultipartUpload` for the Amazon S3 object. + MultipartUploadId: + type: string + MultipartUploadList: + type: array + items: + $ref: '#/components/schemas/MultipartUpload' + NextKeyMarker: + type: string + NextMarker: + type: string + NextPartNumberMarker: + type: string + NextToken: + type: string + NextUploadIdMarker: + type: string + NextVersionIdMarker: + type: string + NoSuchBucket: + type: object + properties: {} + description: The specified bucket does not exist. + NoSuchKey: + type: object + properties: {} + description: The specified key does not exist. + NoSuchUpload: + type: object + properties: {} + description: The specified multipart upload does not exist. + NoncurrentVersionExpiration: + type: object + properties: + NoncurrentDays: + $ref: '#/components/schemas/Days' + description: 'Specifies the number of days an object is noncurrent before + Amazon S3 can perform the associated action. The value must be a non-zero + positive integer. For information about the noncurrent days calculations, + see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) + in the _Amazon S3 User Guide_. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + NewerNoncurrentVersions: + $ref: '#/components/schemas/VersionCount' + description: 'Specifies how many noncurrent versions Amazon S3 will retain. + You can specify up to 100 noncurrent versions to retain. Amazon S3 will + permanently delete any additional noncurrent versions beyond the specified + number to retain. For more information about noncurrent versions, see + [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) + in the _Amazon S3 User Guide_. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + description: 'Specifies when noncurrent object versions expire. Upon expiration, + Amazon S3 permanently deletes the noncurrent object versions. You set this + lifecycle configuration action on a bucket that has versioning enabled (or + suspended) to request that Amazon S3 delete noncurrent object versions at + a specific period in the object''s lifetime. + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + NoncurrentVersionTransition: + type: object + properties: + NoncurrentDays: + $ref: '#/components/schemas/Days' + description: Specifies the number of days an object is noncurrent before + Amazon S3 can perform the associated action. For information about the + noncurrent days calculations, see [How Amazon S3 Calculates How Long an + Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) + in the _Amazon S3 User Guide_. + StorageClass: + $ref: '#/components/schemas/TransitionStorageClass' + description: The class of storage used to store the object. + NewerNoncurrentVersions: + $ref: '#/components/schemas/VersionCount' + description: Specifies how many noncurrent versions Amazon S3 will retain + in the same storage class before transitioning objects. You can specify + up to 100 noncurrent versions to retain. Amazon S3 will transition any + additional noncurrent versions beyond the specified number to retain. + For more information about noncurrent versions, see [Lifecycle configuration + elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) + in the _Amazon S3 User Guide_. + description: Container for the transition rule that describes when noncurrent + objects transition to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, + `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class. If your bucket is + versioning-enabled (or versioning is suspended), you can set this action to + request that Amazon S3 transition noncurrent object versions to the `STANDARD_IA`, + `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` + storage class at a specific period in the object's lifetime. + NoncurrentVersionTransitionList: + type: array + items: + $ref: '#/components/schemas/NoncurrentVersionTransition' + NotFound: + type: object + properties: {} + description: The specified content does not exist. + NotificationConfiguration: + type: object + properties: + TopicConfigurations: + $ref: '#/components/schemas/TopicConfigurationList' + description: The topic to which notifications are sent and the events for + which notifications are generated. + QueueConfigurations: + $ref: '#/components/schemas/QueueConfigurationList' + description: The Amazon Simple Queue Service queues to publish messages + to and the events for which to publish messages. + LambdaFunctionConfigurations: + $ref: '#/components/schemas/LambdaFunctionConfigurationList' + description: Describes the Lambda functions to invoke and the events for + which to invoke them. + EventBridgeConfiguration: + $ref: '#/components/schemas/EventBridgeConfiguration' + description: Enables delivery of events to Amazon EventBridge. + description: A container for specifying the notification configuration of the + bucket. If this element is empty, notifications are turned off for the bucket. + NotificationConfigurationFilter: + type: object + properties: + Key: + $ref: '#/components/schemas/S3KeyFilter' + description: Specifies object key name filtering rules. For information about + key name filtering, see [Configuring event notifications using object key + name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) + in the _Amazon S3 User Guide_. + NotificationId: + type: string + Object: + type: object + properties: + Key: + $ref: '#/components/schemas/ObjectKey' + description: The name that you assign to an object. You use the object key + to retrieve the object. + LastModified: + $ref: '#/components/schemas/LastModified' + description: Creation date of the object. + ETag: + $ref: '#/components/schemas/ETag' + description: "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:\n\n * 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.\n\n * 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.\n\n * 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.\n\n**Directory buckets** \\- MD5 is\ + \ not supported by directory buckets." + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithmList' + description: The algorithm that was used to create a checksum of the object. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type that is used to calculate the object’s checksum + value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + Size: + $ref: '#/components/schemas/Size' + description: Size in bytes of the object + StorageClass: + $ref: '#/components/schemas/ObjectStorageClass' + description: 'The class of storage used to store the object. + + + **Directory buckets** \- Directory buckets only support `EXPRESS_ONEZONE` + (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` + (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.' + Owner: + $ref: '#/components/schemas/Owner' + description: 'The owner of the object + + + **Directory buckets** \- The bucket owner is returned as the object owner.' + RestoreStatus: + $ref: '#/components/schemas/RestoreStatus' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets. Directory buckets + only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) + in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access + storage class) in Dedicated Local Zones.' + description: An object consists of data and its descriptive metadata. + ObjectAlreadyInActiveTierError: + type: object + properties: {} + description: This action is not allowed against this storage tier. + ObjectAttributes: + type: string + enum: + - ETag + - Checksum + - ObjectParts + - StorageClass + - ObjectSize + ObjectAttributesList: + type: array + items: + $ref: '#/components/schemas/ObjectAttributes' + ObjectCannedACL: + type: string + enum: + - private + - public-read + - public-read-write + - authenticated-read + - aws-exec-read + - bucket-owner-read + - bucket-owner-full-control + ObjectIdentifier: + type: object + properties: + Key: + $ref: '#/components/schemas/ObjectKey' + description: 'Key name of the object. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID for the specific version of the object to delete. + + + This functionality is not supported for directory buckets.' + ETag: + $ref: '#/components/schemas/ETag' + description: 'An entity tag (ETag) is an identifier assigned by a web server + to a specific version of a resource found at a URL. This header field + makes the request method conditional on `ETags`. + + + Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings + unique to the object.' + LastModifiedTime: + $ref: '#/components/schemas/LastModifiedTime' + description: 'If present, the objects are deleted only if its modification + times matches the provided `Timestamp`. + + + This functionality is only supported for directory buckets.' + Size: + $ref: '#/components/schemas/Size' + description: 'If present, the objects are deleted only if its size matches + the provided size in bytes. + + + This functionality is only supported for directory buckets.' + required: + - Key + description: Object Identifier is unique value to identify objects. + ObjectIdentifierList: + type: array + items: + $ref: '#/components/schemas/ObjectIdentifier' + ObjectKey: + type: string + minLength: 1 + ObjectList: + type: array + items: + $ref: '#/components/schemas/Object' + ObjectLockConfiguration: + type: object + properties: + ObjectLockEnabled: + $ref: '#/components/schemas/ObjectLockEnabled' + description: Indicates whether this bucket has an Object Lock configuration + enabled. Enable `ObjectLockEnabled` when you apply `ObjectLockConfiguration` + to a bucket. + Rule: + $ref: '#/components/schemas/ObjectLockRule' + description: Specifies the Object Lock rule for the specified object. Enable + the this rule when you apply `ObjectLockConfiguration` to a bucket. Bucket + settings require both a mode and a period. The period can be either `Days` + or `Years` but you must select one. You cannot specify `Days` and `Years` + at the same time. + description: The container element for Object Lock configuration parameters. + ObjectLockEnabled: + type: string + enum: + - Enabled + ObjectLockEnabledForBucket: + type: boolean + ObjectLockLegalHold: + type: object + properties: + Status: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: Indicates whether the specified object has a legal hold in + place. + description: A legal hold configuration for an object. + ObjectLockLegalHoldStatus: + type: string + enum: + - 'ON' + - 'OFF' + ObjectLockMode: + type: string + enum: + - GOVERNANCE + - COMPLIANCE + ObjectLockRetainUntilDate: + type: string + format: date-time + ObjectLockRetention: + type: object + properties: + Mode: + $ref: '#/components/schemas/ObjectLockRetentionMode' + description: Indicates the Retention mode for the specified object. + RetainUntilDate: + $ref: '#/components/schemas/Date' + description: The date on which this Object Lock Retention will expire. + description: A Retention configuration for an object. + ObjectLockRetentionMode: + type: string + enum: + - GOVERNANCE + - COMPLIANCE + ObjectLockRule: + type: object + properties: + DefaultRetention: + $ref: '#/components/schemas/DefaultRetention' + description: The default Object Lock retention mode and period that you + want to apply to new objects placed in the specified bucket. Bucket settings + require both a mode and a period. The period can be either `Days` or `Years` + but you must select one. You cannot specify `Days` and `Years` at the + same time. + description: The container element for an Object Lock rule. + ObjectLockToken: + type: string + ObjectNotInActiveTierError: + type: object + properties: {} + description: The source object of the COPY action is not in the active tier + and is only stored in Amazon S3 Glacier. + ObjectOwnership: + type: string + enum: + - BucketOwnerPreferred + - ObjectWriter + - BucketOwnerEnforced + description: "

The container element for object ownership for a bucket's ownership\ + \ controls.

\n

\n BucketOwnerPreferred\ + \ - Objects uploaded to the bucket change ownership to the bucket\n owner\ + \ if the objects are uploaded with the bucket-owner-full-control\ + \ canned ACL.

\n

\n ObjectWriter - The\ + \ uploading account will own the object if the object is uploaded with\n \ + \ the bucket-owner-full-control canned ACL.

\n \ + \

\n BucketOwnerEnforced - Access control lists\ + \ (ACLs) are disabled and no longer affect\n permissions. The bucket\ + \ owner automatically owns and has full control over every object in the bucket.\n\ + \ The bucket only accepts PUT requests that don't specify an ACL or specify\ + \ bucket owner full control ACLs\n (such as the predefined bucket-owner-full-control\ + \ canned ACL or a custom ACL in XML format\n that grants the same permissions).

\n\ + \

By default, ObjectOwnership is set to BucketOwnerEnforced\ + \ and ACLs are\n disabled. We recommend keeping ACLs disabled, except\ + \ in uncommon use cases where you must control access\n for each object\ + \ individually. For more information about S3 Object Ownership, see Controlling\n ownership of objects and disabling ACLs for your bucket\ + \ in the\n Amazon S3 User Guide.

\n \n \ + \

This functionality is not supported for directory buckets. Directory\ + \ buckets use the bucket owner enforced setting for S3 Object Ownership.

\n\ + \ " + ObjectPart: + type: object + properties: + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: The part number identifying the part. This value is a positive + integer between 1 and 10,000. + Size: + $ref: '#/components/schemas/Size' + description: The size of the uploaded part in bytes. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32` checksum of the part. This + checksum is present if the multipart upload request was created with the + `CRC32` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the part. This + checksum is present if the multipart upload request was created with the + `CRC32C` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. + This checksum is present if the multipart upload request was created with + the `CRC64NVME` checksum algorithm, or if the object was uploaded without + a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to + the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` checksum of the part. This + checksum is present if the multipart upload request was created with the + `SHA1` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` checksum of the part. + This checksum is present if the multipart upload request was created with + the `SHA256` checksum algorithm. For more information, see [Checking object + integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + description: A container for elements related to an individual part. + ObjectSize: + type: integer + format: int64 + ObjectSizeGreaterThanBytes: + type: integer + format: int64 + ObjectSizeLessThanBytes: + type: integer + format: int64 + ObjectStorageClass: + type: string + enum: + - STANDARD + - REDUCED_REDUNDANCY + - GLACIER + - STANDARD_IA + - ONEZONE_IA + - INTELLIGENT_TIERING + - DEEP_ARCHIVE + - OUTPOSTS + - GLACIER_IR + - SNOW + - EXPRESS_ONEZONE + - FSX_OPENZFS + - FSX_ONTAP + ObjectVersion: + type: object + properties: + ETag: + $ref: '#/components/schemas/ETag' + description: The entity tag is an MD5 hash of that version of the object. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithmList' + description: The algorithm that was used to create a checksum of the object. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: The checksum type that is used to calculate the object’s checksum + value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + Size: + $ref: '#/components/schemas/Size' + description: Size in bytes of the object. + StorageClass: + $ref: '#/components/schemas/ObjectVersionStorageClass' + description: The class of storage used to store the object. + Key: + $ref: '#/components/schemas/ObjectKey' + description: The object key. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: Version ID of an object. + IsLatest: + $ref: '#/components/schemas/IsLatest' + description: Specifies whether the object is (true) or is not (false) the + latest version of an object. + LastModified: + $ref: '#/components/schemas/LastModified' + description: Date and time when the object was last modified. + Owner: + $ref: '#/components/schemas/Owner' + description: Specifies the owner of the object. + RestoreStatus: + $ref: '#/components/schemas/RestoreStatus' + description: 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) + in the _Amazon S3 User Guide_. + description: The version of an object. + ObjectVersionId: + type: string + ObjectVersionList: + type: array + items: + $ref: '#/components/schemas/ObjectVersion' + ObjectVersionStorageClass: + type: string + enum: + - STANDARD + OptionalObjectAttributes: + type: string + enum: + - RestoreStatus + OptionalObjectAttributesList: + type: array + items: + $ref: '#/components/schemas/OptionalObjectAttributes' + OutputLocation: + type: object + properties: + S3: + $ref: '#/components/schemas/S3Location' + description: Describes an S3 location that will receive the results of the + restore request. + description: Describes the location where the restore job's output is stored. + OutputSerialization: + type: object + properties: + CSV: + $ref: '#/components/schemas/CSVOutput' + description: Describes the serialization of CSV-encoded Select results. + JSON: + $ref: '#/components/schemas/JSONOutput' + description: Specifies JSON as request's output serialization format. + description: Describes how results of the Select job are serialized. + Owner: + type: object + properties: + DisplayName: + $ref: '#/components/schemas/DisplayName' + description: '' + ID: + $ref: '#/components/schemas/ID' + description: Container for the ID of the owner. + description: Container for the owner's display name and ID. + OwnerOverride: + type: string + enum: + - Destination + OwnershipControls: + type: object + properties: + Rules: + $ref: '#/components/schemas/OwnershipControlsRules' + description: The container element for an ownership control rule. + required: + - Rules + description: The container element for a bucket's ownership controls. + OwnershipControlsRule: + type: object + properties: + ObjectOwnership: + $ref: '#/components/schemas/ObjectOwnership' + required: + - ObjectOwnership + description: The container element for an ownership control rule. + OwnershipControlsRules: + type: array + items: + $ref: '#/components/schemas/OwnershipControlsRule' + ParquetInput: + type: object + properties: {} + description: Container for Parquet. + Part: + type: object + properties: + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: Part number identifying the part. This is a positive integer + between 1 and 10,000. + LastModified: + $ref: '#/components/schemas/LastModified' + description: Date and time at which the part was uploaded. + ETag: + $ref: '#/components/schemas/ETag' + description: Entity tag returned when the part was uploaded. + Size: + $ref: '#/components/schemas/Size' + description: Size in bytes of the uploaded part data. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32` checksum of the part. This + checksum is present if the object was uploaded with the `CRC32` checksum + algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the part. This + checksum is present if the object was uploaded with the `CRC32C` checksum + algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. + This checksum is present if the multipart upload request was created with + the `CRC64NVME` checksum algorithm, or if the object was uploaded without + a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to + the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` checksum of the part. This + checksum is present if the object was uploaded with the `SHA1` checksum + algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` checksum of the part. + This checksum is present if the object was uploaded with the `SHA256` + checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + description: Container for elements related to a part. + PartNumber: + type: integer + PartNumberMarker: + type: string + PartitionDateSource: + type: string + enum: + - EventTime + - DeliveryTime + PartitionedPrefix: + type: object + properties: + PartitionDateSource: + $ref: '#/components/schemas/PartitionDateSource' + description: 'Specifies the partition date source for the partitioned prefix. + `PartitionDateSource` can be `EventTime` or `DeliveryTime`. + + + For `DeliveryTime`, the time in the log file names corresponds to the + delivery time for the log files. + + + For `EventTime`, The logs delivered are for a specific day only. The year, + month, and day correspond to the day on which the event occurred, and + the hour, minutes and seconds are set to 00 in the key.' + description: 'Amazon S3 keys for log objects are partitioned in the following + format: + + + `[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]` + + + PartitionedPrefix defaults to EventTime delivery when server access logs are + delivered.' + Parts: + type: array + items: + $ref: '#/components/schemas/Part' + PartsCount: + type: integer + PartsList: + type: array + items: + $ref: '#/components/schemas/ObjectPart' + Payer: + type: string + enum: + - Requester + - BucketOwner + Permission: + type: string + enum: + - FULL_CONTROL + - WRITE + - WRITE_ACP + - READ + - READ_ACP + Policy: + type: string + PolicyStatus: + type: object + properties: + IsPublic: + $ref: '#/components/schemas/IsPublic' + description: The policy status for this bucket. `TRUE` indicates that this + bucket is public. `FALSE` indicates that the bucket is not public. + description: The container element for a bucket's policy status. + Prefix: + type: string + Priority: + type: integer + Progress: + type: object + properties: + BytesScanned: + $ref: '#/components/schemas/BytesScanned' + description: The current number of object bytes scanned. + BytesProcessed: + $ref: '#/components/schemas/BytesProcessed' + description: The current number of uncompressed object bytes processed. + BytesReturned: + $ref: '#/components/schemas/BytesReturned' + description: The current number of bytes of records payload data returned. + description: This data type contains information about progress of an operation. + ProgressEvent: + type: object + properties: + Details: + $ref: '#/components/schemas/Progress' + description: The Progress event details. + description: This data type contains information about the progress event of + an operation. + Protocol: + type: string + enum: + - http + - https + PublicAccessBlockConfiguration: + type: object + properties: + BlockPublicAcls: + $ref: '#/components/schemas/Setting' + description: "Specifies whether Amazon S3 should block public access control\ + \ lists (ACLs) for this bucket and objects in this bucket. Setting this\ + \ element to `TRUE` causes the following behavior:\n\n * PUT Bucket ACL\ + \ and PUT Object ACL calls fail if the specified ACL is public.\n\n *\ + \ PUT Object calls fail if the request includes a public ACL.\n\n * PUT\ + \ Bucket calls fail if the request includes a public ACL.\n\nEnabling\ + \ this setting doesn't affect existing policies or ACLs." + IgnorePublicAcls: + $ref: '#/components/schemas/Setting' + description: 'Specifies whether Amazon S3 should ignore public ACLs for + this bucket and objects in this bucket. Setting this element to `TRUE` + causes Amazon S3 to ignore all public ACLs on this bucket and objects + in this bucket. + + + Enabling this setting doesn''t affect the persistence of any existing + ACLs and doesn''t prevent new public ACLs from being set.' + BlockPublicPolicy: + $ref: '#/components/schemas/Setting' + description: 'Specifies whether Amazon S3 should block public bucket policies + for this bucket. Setting this element to `TRUE` causes Amazon S3 to reject + calls to PUT Bucket policy if the specified bucket policy allows public + access. + + + Enabling this setting doesn''t affect existing bucket policies.' + RestrictPublicBuckets: + $ref: '#/components/schemas/Setting' + description: 'Specifies whether Amazon S3 should restrict public bucket + policies for this bucket. Setting this element to `TRUE` restricts access + to this bucket to only Amazon Web Services service principals and authorized + users within this account if the bucket has a public policy. + + + Enabling this setting doesn''t affect previously stored bucket policies, + except that public and cross-account access within any public bucket policy, + including non-public delegation to specific accounts, is blocked.' + description: The PublicAccessBlock configuration that you want to apply to this + Amazon S3 bucket. You can enable the configuration options in any combination. + Bucket-level settings work alongside account-level settings (which may inherit + from organization-level policies). For more information about when Amazon + S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + in the _Amazon S3 User Guide_. + PutBucketAbacRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the general purpose bucket. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash of the `PutBucketAbac` request body. + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: Indicates the algorithm that you want Amazon S3 to use to create + the checksum. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The Amazon Web Services account ID of the general purpose bucket's + owner. + AbacStatus: + $ref: '#/components/schemas/AbacStatus' + description: The ABAC status of the general purpose bucket. When ABAC is + enabled for the general purpose bucket, you can use tags to manage access + to the general purpose buckets as well as for cost tracking purposes. + When ABAC is disabled for the general purpose buckets, you can only use + tags for cost tracking purposes. For more information, see [Using tags + with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html). + required: + - Bucket + - AbacStatus + PutBucketAccelerateConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which the accelerate configuration + is set. + AccelerateConfiguration: + $ref: '#/components/schemas/AccelerateConfiguration' + description: Container for setting the transfer acceleration state. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + required: + - Bucket + - AccelerateConfiguration + PutBucketAclRequest: + type: object + properties: + ACL: + $ref: '#/components/schemas/BucketCannedACL' + description: The canned ACL to apply to the bucket. + AccessControlPolicy: + $ref: '#/components/schemas/AccessControlPolicy' + description: Contains the elements that set the ACL permissions for an object + per grantee. + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket to which to apply the ACL. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. This + header must be used as a message integrity check to verify that the request + body was not corrupted in transit. For more information, go to [RFC 1864.](http://www.ietf.org/rfc/rfc1864.txt) + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + GrantFullControl: + $ref: '#/components/schemas/GrantFullControl' + description: Allows grantee the read, write, read ACP, and write ACP permissions + on the bucket. + GrantRead: + $ref: '#/components/schemas/GrantRead' + description: Allows grantee to list the objects in the bucket. + GrantReadACP: + $ref: '#/components/schemas/GrantReadACP' + description: Allows grantee to read the bucket ACL. + GrantWrite: + $ref: '#/components/schemas/GrantWrite' + description: '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.' + GrantWriteACP: + $ref: '#/components/schemas/GrantWriteACP' + description: Allows grantee to write the ACL for the applicable bucket. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + PutBucketAnalyticsConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket to which an analytics configuration + is stored. + Id: + $ref: '#/components/schemas/AnalyticsId' + description: The ID that identifies the analytics configuration. + AnalyticsConfiguration: + $ref: '#/components/schemas/AnalyticsConfiguration' + description: The configuration and any analyses for the analytics filter. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + - AnalyticsConfiguration + PutBucketCorsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: Specifies the bucket impacted by the `cors`configuration. + CORSConfiguration: + $ref: '#/components/schemas/CORSConfiguration' + description: Describes the cross-origin access configuration for objects + in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin + Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) + in the _Amazon S3 User Guide_. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. This + header must be used as a message integrity check to verify that the request + body was not corrupted in transit. For more information, go to [RFC 1864.](http://www.ietf.org/rfc/rfc1864.txt) + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - CORSConfiguration + PutBucketEncryptionRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'Specifies default encryption for a bucket using server-side + encryption with different key options. + + + **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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the server-side + encryption configuration. + + + 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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter. + + + For directory buckets, when you use Amazon Web Services SDKs, `CRC32` + is the default checksum algorithm that''s used for performance.' + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + - ServerSideEncryptionConfiguration + PutBucketIntelligentTieringConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose configuration you want + to modify or retrieve. + Id: + $ref: '#/components/schemas/IntelligentTieringId' + description: The ID used to identify the S3 Intelligent-Tiering configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + IntelligentTieringConfiguration: + $ref: '#/components/schemas/IntelligentTieringConfiguration' + description: Container for S3 Intelligent-Tiering configuration. + required: + - Bucket + - Id + - IntelligentTieringConfiguration + PutBucketInventoryConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket where the inventory configuration will + be stored. + Id: + $ref: '#/components/schemas/InventoryId' + description: The ID used to identify the inventory configuration. + InventoryConfiguration: + $ref: '#/components/schemas/InventoryConfiguration' + description: Specifies the inventory configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + - InventoryConfiguration + PutBucketLifecycleConfigurationOutput: + type: object + properties: + TransitionDefaultMinimumObjectSize: + $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' + description: "Indicates which default minimum object size behavior is applied\ + \ to the lifecycle configuration.\n\nThis parameter applies to general\ + \ purpose buckets only. It is not supported for directory bucket lifecycle\ + \ configurations.\n\n * `all_storage_classes_128K` \\- Objects smaller\ + \ than 128 KB will not transition to any storage class by default. \n\n\ + \ * `varies_by_storage_class` \\- Objects smaller than 128 KB will transition\ + \ to Glacier Flexible Retrieval or Glacier Deep Archive storage classes.\ + \ By default, all other storage classes will prevent transitions smaller\ + \ than 128 KB. \n\nTo customize the minimum object size for any transition\ + \ you can add a filter that specifies a custom `ObjectSizeGreaterThan`\ + \ or `ObjectSizeLessThan` in the body of your transition rule. Custom\ + \ filters always take precedence over the default transition behavior." + PutBucketLifecycleConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which to set the configuration. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + LifecycleConfiguration: + $ref: '#/components/schemas/BucketLifecycleConfiguration' + description: Container for lifecycle rules. You can add as many as 1,000 + rules. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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). + + + This parameter applies to general purpose buckets only. It is not supported + for directory bucket lifecycle configurations.' + TransitionDefaultMinimumObjectSize: + $ref: '#/components/schemas/TransitionDefaultMinimumObjectSize' + description: "Indicates which default minimum object size behavior is applied\ + \ to the lifecycle configuration.\n\nThis parameter applies to general\ + \ purpose buckets only. It is not supported for directory bucket lifecycle\ + \ configurations.\n\n * `all_storage_classes_128K` \\- Objects smaller\ + \ than 128 KB will not transition to any storage class by default. \n\n\ + \ * `varies_by_storage_class` \\- Objects smaller than 128 KB will transition\ + \ to Glacier Flexible Retrieval or Glacier Deep Archive storage classes.\ + \ By default, all other storage classes will prevent transitions smaller\ + \ than 128 KB. \n\nTo customize the minimum object size for any transition\ + \ you can add a filter that specifies a custom `ObjectSizeGreaterThan`\ + \ or `ObjectSizeLessThan` in the body of your transition rule. Custom\ + \ filters always take precedence over the default transition behavior." + required: + - Bucket + PutBucketLoggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which to set the logging parameters. + BucketLoggingStatus: + $ref: '#/components/schemas/BucketLoggingStatus' + description: Container for logging status information. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash of the `PutBucketLogging` request body. + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - BucketLoggingStatus + PutBucketMetricsConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket for which the metrics configuration + is set. + Id: + $ref: '#/components/schemas/MetricsId' + description: The ID used to identify the metrics configuration. The ID has + a 64 character limit and can only contain letters, numbers, periods, dashes, + and underscores. + MetricsConfiguration: + $ref: '#/components/schemas/MetricsConfiguration' + description: Specifies the metrics configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Id + - MetricsConfiguration + PutBucketNotificationConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket. + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + SkipDestinationValidation: + $ref: '#/components/schemas/SkipValidation' + description: Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. + True or false value. + required: + - Bucket + - NotificationConfiguration + PutBucketOwnershipControlsRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose `OwnershipControls` + you want to set. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash of the `OwnershipControls` request body. + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + OwnershipControls: + $ref: '#/components/schemas/OwnershipControls' + description: The `OwnershipControls` (BucketOwnerEnforced, BucketOwnerPreferred, + or ObjectWriter) that you want to apply to this Amazon S3 bucket. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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_ ` header sent. Otherwise, + Amazon S3 fails the request with the HTTP status code `400 Bad Request`. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + required: + - Bucket + - OwnershipControls + PutBucketPolicyRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 Zone (Availability Zone or Local Zone). Bucket + names must also follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` + (for example, ` _DOC-EXAMPLE-BUCKET_ --_usw2-az1_ --x-s3`). For information + about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_' + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: '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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: "Indicates the algorithm used to create the checksum for the\ + \ request 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`.\n\nFor the `x-amz-checksum-_algorithm_ ` header,\ + \ replace ` _algorithm_ ` with the supported algorithm from the following\ + \ list:\n\n * `CRC32`\n\n * `CRC32C`\n\n * `CRC64NVME`\n\n * `SHA1`\n\ + \n * `SHA256`\n\nFor more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)\ + \ in the _Amazon S3 User Guide_.\n\nIf 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\ + \ fails the request with a `BadDigest` error.\n\nFor directory buckets,\ + \ when you use Amazon Web Services SDKs, `CRC32` is the default checksum\ + \ algorithm that's used for performance." + ConfirmRemoveSelfBucketAccess: + $ref: '#/components/schemas/ConfirmRemoveSelfBucketAccess' + description: '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.' + Policy: + $ref: '#/components/schemas/Policy' + description: 'The bucket policy as a JSON document. + + + For directory buckets, the only IAM action supported in the bucket policy + is `s3express:CreateSession`.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: '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`.' + required: + - Bucket + - Policy + PutBucketReplicationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must + use this header as a message integrity check to verify that the request + body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + Token: + $ref: '#/components/schemas/ObjectLockToken' + description: A token to allow Object Lock to be enabled for an existing + bucket. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - ReplicationConfiguration + PutBucketRequestPaymentRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must + use this header as a message integrity check to verify that the request + body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + RequestPaymentConfiguration: + $ref: '#/components/schemas/RequestPaymentConfiguration' + description: Container for Payer. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - RequestPaymentConfiguration + PutBucketTaggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must + use this header as a message integrity check to verify that the request + body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + Tagging: + $ref: '#/components/schemas/Tagging' + description: Container for the `TagSet` and `Tag` elements. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Tagging + PutBucketVersioningRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: '>The Base64 encoded 128-bit `MD5` digest of the data. You + must use this header as a message integrity check to verify that the request + body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + MFA: + $ref: '#/components/schemas/MFA' + description: The concatenation of the authentication device's serial number, + a space, and the value that is displayed on your authentication device. + The serial number is the number that uniquely identifies the MFA device. + For physical MFA devices, this is the unique serial number that's provided + with the device. For virtual MFA devices, the serial number is the device + ARN. For more information, see [Enabling versioning on buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html) + and [Configuring MFA delete](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiFactorAuthenticationDelete.html) + in the _Amazon Simple Storage Service User Guide_. + VersioningConfiguration: + $ref: '#/components/schemas/VersioningConfiguration' + description: Container for setting the versioning state. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - VersioningConfiguration + PutBucketWebsiteRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket name. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. You must + use this header as a message integrity check to verify that the request + body was not corrupted in transit. For more information, see [RFC 1864](http://www.ietf.org/rfc/rfc1864.txt). + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: 'Indicates the algorithm used to create the checksum for the + request 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + WebsiteConfiguration: + $ref: '#/components/schemas/WebsiteConfiguration' + description: Container for the request. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - WebsiteConfiguration + PutObjectAclOutput: + type: object + properties: + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + PutObjectAclRequest: + type: object + properties: + ACL: + $ref: '#/components/schemas/ObjectCannedACL' + description: The canned ACL to apply to the object. For more information, + see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). + AccessControlPolicy: + $ref: '#/components/schemas/AccessControlPolicy' + description: Contains the elements that set the ACL permissions for an object + per grantee. + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The Base64 encoded 128-bit `MD5` digest of the data. This + header must be used as a message integrity check to verify that the request + body was not corrupted in transit. For more information, go to [RFC 1864.>](http://www.ietf.org/rfc/rfc1864.txt) + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + GrantFullControl: + $ref: '#/components/schemas/GrantFullControl' + description: 'Allows grantee the read, write, read ACP, and write ACP permissions + on the bucket. + + + This functionality is not supported for Amazon S3 on Outposts.' + GrantRead: + $ref: '#/components/schemas/GrantRead' + description: 'Allows grantee to list the objects in the bucket. + + + This functionality is not supported for Amazon S3 on Outposts.' + GrantReadACP: + $ref: '#/components/schemas/GrantReadACP' + description: 'Allows grantee to read the bucket ACL. + + + This functionality is not supported for Amazon S3 on Outposts.' + GrantWrite: + $ref: '#/components/schemas/GrantWrite' + description: '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.' + GrantWriteACP: + $ref: '#/components/schemas/GrantWriteACP' + description: 'Allows grantee to write the ACL for the applicable bucket. + + + This functionality is not supported for Amazon S3 on Outposts.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Key for which the PUT action was initiated. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: 'Version ID used to reference a specific version of the object. + + + This functionality is not supported for directory buckets.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + PutObjectLegalHoldOutput: + type: object + properties: + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + PutObjectLegalHoldRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key name for the object that you want to place a legal + hold on. + LegalHold: + $ref: '#/components/schemas/ObjectLockLegalHold' + description: Container element for the legal hold configuration you want + to apply to the specified object. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The version ID of the object that you want to place a legal + hold on. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash for 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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + PutObjectLockConfigurationOutput: + type: object + properties: + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + PutObjectLockConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The bucket whose Object Lock configuration you want to create + or replace. + ObjectLockConfiguration: + $ref: '#/components/schemas/ObjectLockConfiguration' + description: The Object Lock configuration that you want to apply to the + specified bucket. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + Token: + $ref: '#/components/schemas/ObjectLockToken' + description: A token to allow Object Lock to be enabled for an existing + bucket. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash for 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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + PutObjectOutput: + type: object + properties: + Expiration: + $ref: '#/components/schemas/Expiration' + description: 'If the expiration is configured for the object (see [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)) + 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. + + + Object expiration information is not returned in directory buckets and + this header returns the value "`NotImplemented`" in all responses for + directory buckets.' + ETag: + $ref: '#/components/schemas/ETag' + description: '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.' + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. + This header is present if the object was uploaded with the `CRC64NVME` + checksum algorithm, or if it was uploaded without a checksum (and Amazon + S3 added the default checksum, `CRC64NVME`, to the uploaded object). For + more information about how checksums are calculated with multipart uploads, + see [Checking object integrity in the Amazon S3 User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumType: + $ref: '#/components/schemas/ChecksumType' + description: This header specifies the checksum type of the object, which + determines how part-level checksums are combined to create an object-level + checksum for multipart objects. For `PutObject` uploads, the checksum + type is always `FULL_OBJECT`. You can use this header as a data integrity + check to verify that the checksum type that is received is the same checksum + that was specified. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html) + in the _Amazon S3 User Guide_. For information about returning the versioning + state of a bucket, see [GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html). + + + This functionality is not supported for directory buckets.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: If present, indicates the Amazon Web Services KMS Encryption + Context to use for object encryption. The value of this header is a Base64 + encoded string of a UTF-8 encoded JSON, which contains the encryption + context as key-value pairs. This value is stored as object metadata and + automatically gets passed on to Amazon Web Services KMS for future `GetObject` + operations on this object. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the uploaded object uses an S3 Bucket Key + for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). + Size: + $ref: '#/components/schemas/Size' + description: 'The size of the object in bytes. This value is only be present + if you append to an object. + + + This functionality is only supported for objects in the Amazon S3 Express + One Zone storage class in directory buckets.' + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + PutObjectRequest: + type: object + properties: + ACL: + $ref: '#/components/schemas/ObjectCannedACL' + description: "The canned ACL to apply to the object. For more information,\ + \ see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL)\ + \ in the _Amazon S3 User Guide_.\n\nWhen 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)\ + \ and [Managing ACLs Using the REST API](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html)\ + \ in the _Amazon S3 User Guide_.\n\nIf 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)\ + \ in the _Amazon S3 User Guide_.\n\n * This functionality is not supported\ + \ for directory buckets.\n\n * This functionality is not supported for\ + \ Amazon S3 on Outposts." + Body: + $ref: '#/components/schemas/StreamingBlob' + description: Object data. + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + CacheControl: + $ref: '#/components/schemas/CacheControl' + description: Can be used to specify caching behavior along the request/reply + chain. For more information, see . + ContentDisposition: + $ref: '#/components/schemas/ContentDisposition' + description: Specifies presentational information for the object. For more + information, see . + ContentEncoding: + $ref: '#/components/schemas/ContentEncoding' + description: 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 more information, see + . + ContentLanguage: + $ref: '#/components/schemas/ContentLanguage' + description: The language the content is in. + ContentLength: + $ref: '#/components/schemas/ContentLength' + description: Size of the body in bytes. This parameter is useful when the + size of the body cannot be determined automatically. For more information, + see . + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). + + + The `Content-MD5` or `x-amz-sdk-checksum-algorithm` header is required + for any request to upload an object with a retention period configured + using Amazon S3 Object Lock. For more information, see [Uploading objects + to an Object Lock enabled bucket ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + ContentType: + $ref: '#/components/schemas/ContentType' + description: A standard MIME type describing the format of the contents. + For more information, see . + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: "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`.\n\nFor the `x-amz-checksum-_algorithm_ ` header,\ + \ replace ` _algorithm_ ` with the supported algorithm from the following\ + \ list:\n\n * `CRC32`\n\n * `CRC32C`\n\n * `CRC64NVME`\n\n * `SHA1`\n\ + \n * `SHA256`\n\nFor more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)\ + \ in the _Amazon S3 User Guide_.\n\nIf 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\ + \ fails the request with a `BadDigest` error.\n\nThe `Content-MD5` or\ + \ `x-amz-sdk-checksum-algorithm` header is required for any request to\ + \ upload an object with a retention period configured using Amazon S3\ + \ Object Lock. For more information, see [Uploading objects to an Object\ + \ Lock enabled bucket ](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object)\ + \ in the _Amazon S3 User Guide_.\n\nFor directory buckets, when you use\ + \ Amazon Web Services SDKs, `CRC32` is the default checksum algorithm\ + \ that's used for performance." + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32` checksum of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the + object. The `CRC64NVME` checksum is always a full object checksum. For + more information, see [Checking object integrity in the Amazon S3 User + Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html). + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 160-bit `SHA1` digest of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 256-bit `SHA256` digest of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + Expires: + $ref: '#/components/schemas/Expires' + description: The date and time at which the object is no longer cacheable. + For more information, see . + IfMatch: + $ref: '#/components/schemas/IfMatch' + description: 'Uploads the object only if the ETag (entity tag) value provided + during the WRITE operation matches the ETag of the object in S3. If the + ETag values do not match, the operation returns a `412 Precondition Failed` + error. + + + If a conflicting operation occurs during the upload S3 returns a `409 + ConditionalRequestConflict` response. On a 409 failure you should fetch + the object''s ETag and retry the upload. + + + Expects the ETag value as a string. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), + or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) + in the _Amazon S3 User Guide_.' + IfNoneMatch: + $ref: '#/components/schemas/IfNoneMatch' + description: 'Uploads the object only if the object key name does not already + exist in the bucket specified. Otherwise, Amazon S3 returns a `412 Precondition + Failed` error. + + + If a conflicting operation occurs during the upload S3 returns a `409 + ConditionalRequestConflict` response. On a 409 failure you should retry + the upload. + + + Expects the ''*'' (asterisk) character. + + + For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232), + or [Conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) + in the _Amazon S3 User Guide_.' + GrantFullControl: + $ref: '#/components/schemas/GrantFullControl' + description: "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions\ + \ on the object.\n\n * This functionality is not supported for directory\ + \ buckets.\n\n * This functionality is not supported for Amazon S3 on\ + \ Outposts." + GrantRead: + $ref: '#/components/schemas/GrantRead' + description: "Allows grantee to read the object data and its metadata.\n\ + \n * This functionality is not supported for directory buckets.\n\n \ + \ * This functionality is not supported for Amazon S3 on Outposts." + GrantReadACP: + $ref: '#/components/schemas/GrantReadACP' + description: "Allows grantee to read the object ACL.\n\n * This functionality\ + \ is not supported for directory buckets.\n\n * This functionality is\ + \ not supported for Amazon S3 on Outposts." + GrantWriteACP: + $ref: '#/components/schemas/GrantWriteACP' + description: "Allows grantee to write the ACL for the applicable object.\n\ + \n * This functionality is not supported for directory buckets.\n\n \ + \ * This functionality is not supported for Amazon S3 on Outposts." + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the PUT action was initiated. + WriteOffsetBytes: + $ref: '#/components/schemas/WriteOffsetBytes' + description: 'Specifies the offset for appending data to existing objects + in bytes. The offset must be equal to the size of the existing object + being appended to. If no object exists, setting this header to 0 will + create a new object. + + + This functionality is only supported for objects in the Amazon S3 Express + One Zone storage class in directory buckets.' + Metadata: + $ref: '#/components/schemas/Metadata' + description: A map of metadata to store with the object in S3. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: "The server-side encryption algorithm that was used when you\ + \ store this object in Amazon S3 or Amazon FSx.\n\n * **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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)\ + \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- For\ + \ directory buckets, there are only two supported options for server-side\ + \ encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)\ + \ (`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).\ + \ We recommend that the bucket's default encryption uses the desired encryption\ + \ configuration and you don't override the bucket default encryption in\ + \ your `CreateSession` requests or `PUT` object requests. Then, new objects\ + \ are automatically encrypted with the desired encryption settings. For\ + \ more information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)\ + \ in the _Amazon S3 User Guide_. For more information about the encryption\ + \ overriding behaviors in directory buckets, see [Specifying server-side\ + \ encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).\ + \ \n\nIn the Zonal endpoint API calls (except [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ + \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))\ + \ using the REST API, the encryption request headers must match the encryption\ + \ settings that are specified in the `CreateSession` request. You can't\ + \ override the values of the encryption settings (`x-amz-server-side-encryption`,\ + \ `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`,\ + \ and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified\ + \ in the `CreateSession` request. You don't need to explicitly specify\ + \ these encryption settings values in Zonal endpoint API calls, and Amazon\ + \ S3 will use the encryption settings values from the `CreateSession`\ + \ request to protect new objects in the directory bucket.\n\nWhen you\ + \ use the CLI or the Amazon Web Services SDKs, for `CreateSession`, the\ + \ session token refreshes automatically to avoid service interruptions\ + \ when a session expires. The CLI or the Amazon Web Services SDKs use\ + \ the bucket's default encryption configuration for the `CreateSession`\ + \ request. It's not supported to override the encryption settings values\ + \ in the `CreateSession` request. So in the Zonal endpoint API calls (except\ + \ [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)\ + \ and [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),\ + \ the encryption request headers must match the default encryption configuration\ + \ of the directory bucket.\n\n * **S3 access points for Amazon FSx**\ + \ \\- When accessing data stored in Amazon FSx file systems using S3 access\ + \ points, the only valid server side encryption option is `aws:fsx`. All\ + \ Amazon FSx file systems have encryption configured by default and are\ + \ encrypted at rest. Data is automatically encrypted before being written\ + \ to the file system, and automatically decrypted as it is read. These\ + \ processes are handled transparently by Amazon FSx." + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: "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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)\ + \ in the _Amazon S3 User Guide_.\n\n * Directory buckets only support\ + \ `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability\ + \ Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class)\ + \ in Dedicated Local Zones.\n\n * Amazon S3 on Outposts only uses the\ + \ OUTPOSTS Storage Class." + WebsiteRedirectLocation: + $ref: '#/components/schemas/WebsiteRedirectLocation' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) + 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) + and [How to Configure Website Page Redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: 'Specifies the algorithm to use when encrypting the object + (for example, `AES256`). + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: 'Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to + use for object encryption. If the KMS key doesn''t exist in the same account + that''s issuing the command, you must use the full Key ARN not the Key + ID. + + + **General purpose buckets** \- If you specify `x-amz-server-side-encryption` + with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, + Key ARN, or Key Alias) of the KMS key to use. 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. + + + **Directory buckets** \- To encrypt data using SSE-KMS, it''s recommended + to specify the `x-amz-server-side-encryption` header to `aws:kms`. Then, + the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses + the bucket''s default KMS customer managed key ID. If you want to explicitly + set the ` x-amz-server-side-encryption-aws-kms-key-id` header, it must + match the bucket''s default customer managed key (using key ID or ARN, + not alias). Your SSE-KMS configuration can only support 1 [customer managed + key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) + per directory bucket''s lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + (`aws/s3`) isn''t supported. Incorrect key specification results in an + HTTP `400 Bad Request` error.' + SSEKMSEncryptionContext: + $ref: '#/components/schemas/SSEKMSEncryptionContext' + description: 'Specifies the Amazon Web Services KMS Encryption Context as + an additional encryption context to use for object encryption. The value + of this header is a Base64 encoded string of a UTF-8 encoded JSON, which + contains the encryption context as key-value pairs. This value is stored + as object metadata and automatically gets passed on to Amazon Web Services + KMS for future `GetObject` operations on this object. + + + **General purpose buckets** \- This value must be explicitly added during + `CopyObject` operations if you want an additional encryption context for + your object. For more information, see [Encryption context](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context) + in the _Amazon S3 User Guide_. + + + **Directory buckets** \- You can optionally provide an explicit encryption + context value. The value must match the default encryption context - the + bucket Amazon Resource Name (ARN). An additional encryption context value + is not supported.' + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: '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). + + + **General purpose buckets** \- Setting this header to `true` causes Amazon + S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying + this header with a PUT action doesn''t affect bucket-level settings for + S3 Bucket Key. + + + **Directory buckets** \- S3 Bucket Keys are always enabled for `GET` and + `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket + Keys aren''t supported, when you copy SSE-KMS encrypted objects from general + purpose buckets to directory buckets, from directory buckets to general + purpose buckets, or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), + [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), + [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), + or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). + In this case, Amazon S3 makes a call to KMS every time a copy request + is made for a KMS-encrypted object.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + Tagging: + $ref: '#/components/schemas/TaggingHeader' + description: '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.' + ObjectLockMode: + $ref: '#/components/schemas/ObjectLockMode' + description: 'The Object Lock mode that you want to apply to this object. + + + This functionality is not supported for directory buckets.' + ObjectLockRetainUntilDate: + $ref: '#/components/schemas/ObjectLockRetainUntilDate' + description: '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.' + ObjectLockLegalHoldStatus: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: 'Specifies whether a legal hold will be applied to this object. + For more information about S3 Object Lock, see [Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + PutObjectRetentionOutput: + type: object + properties: + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + PutObjectRetentionRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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 for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: The key name for the object that you want to apply this Object + Retention configuration to. + Retention: + $ref: '#/components/schemas/ObjectLockRetention' + description: The container element for the Object Retention configuration. + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The version ID for the object that you want to apply this Object + Retention configuration to. + BypassGovernanceRetention: + $ref: '#/components/schemas/BypassGovernanceRetention' + description: Indicates whether this action should bypass Governance-mode + restrictions. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash for 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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + PutObjectTaggingOutput: + type: object + properties: + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The versionId of the object the tag-set was added to. + PutObjectTaggingRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket name containing the object. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Name of the object key. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: The versionId of the object that the tag-set will be added + to. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash for 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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + Tagging: + $ref: '#/components/schemas/Tagging' + description: Container for the `TagSet` and `Tag` elements + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + description: Confirms that the requester knows that she or he will be charged + for the tagging object request. Bucket owners need not specify this parameter + in their requests. + required: + - Bucket + - Key + - Tagging + PutPublicAccessBlockRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The name of the Amazon S3 bucket whose `PublicAccessBlock` + configuration you want to set. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: 'The MD5 hash of the `PutPublicAccessBlock` request body. + + + For requests made using the Amazon Web Services Command Line Interface + (CLI) or Amazon Web Services SDKs, this field is calculated automatically.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + PublicAccessBlockConfiguration: + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + description: The `PublicAccessBlock` configuration that you want to apply + to this Amazon S3 bucket. You can enable the configuration options in + any combination. For more information about when Amazon S3 considers a + bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + in the _Amazon S3 User Guide_. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - PublicAccessBlockConfiguration + QueueArn: + type: string + QueueConfiguration: + type: object + properties: + Id: + $ref: '#/components/schemas/NotificationId' + QueueArn: + $ref: '#/components/schemas/QueueArn' + description: The Amazon Resource Name (ARN) of the Amazon SQS queue to which + Amazon S3 publishes a message when it detects events of the specified + type. + Events: + $ref: '#/components/schemas/EventList' + description: A collection of bucket events for which to send notifications + Filter: + $ref: '#/components/schemas/NotificationConfigurationFilter' + required: + - QueueArn + - Events + description: Specifies the configuration for publishing messages to an Amazon + Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. + QueueConfigurationList: + type: array + items: + $ref: '#/components/schemas/QueueConfiguration' + Quiet: + type: boolean + QuoteCharacter: + type: string + QuoteEscapeCharacter: + type: string + QuoteFields: + type: string + enum: + - ALWAYS + - ASNEEDED + Range: + type: string + RecordDelimiter: + type: string + RecordExpiration: + type: object + properties: + Expiration: + $ref: '#/components/schemas/ExpirationState' + description: Specifies whether journal table record expiration is enabled + or disabled. + Days: + $ref: '#/components/schemas/RecordExpirationDays' + description: If you enable journal table record expiration, you can set + the number of days to retain your journal table records. Journal table + records must be retained for a minimum of 7 days. To set this value, specify + any whole number from `7` to `2147483647`. For example, to retain your + journal table records for one year, set this value to `365`. + required: + - Expiration + description: The journal table record expiration settings for a journal table + in an S3 Metadata configuration. + RecordExpirationDays: + type: integer + RecordsEvent: + type: object + properties: + Payload: + $ref: '#/components/schemas/Body' + description: The byte array of partial, one or more result records. S3 Select + doesn't guarantee that a record will be self-contained in one record frame. + To ensure continuous streaming of data, S3 Select might split the same + record across multiple record frames instead of aggregating the results + in memory. Some S3 clients (for example, the SDK for Java) handle this + behavior by creating a `ByteStream` out of the response by default. Other + clients might not handle this behavior by default. In those cases, you + must aggregate the results on the client side and parse the response. + description: The container for the records event. + Redirect: + type: object + properties: + HostName: + $ref: '#/components/schemas/HostName' + description: The host name to use in the redirect request. + HttpRedirectCode: + $ref: '#/components/schemas/HttpRedirectCode' + description: The HTTP redirect code to use on the response. Not required + if one of the siblings is present. + Protocol: + $ref: '#/components/schemas/Protocol' + description: Protocol to use when redirecting requests. The default is the + protocol that is used in the original request. + ReplaceKeyPrefixWith: + $ref: '#/components/schemas/ReplaceKeyPrefixWith' + description: 'The object key prefix to use in the redirect request. For + example, to redirect requests for all pages with prefix `docs/` (objects + in the `docs/` folder) to `documents/`, you can set a condition block + with `KeyPrefixEquals` set to `docs/` and in the Redirect set `ReplaceKeyPrefixWith` + to `/documents`. Not required if one of the siblings is present. Can be + present only if `ReplaceKeyWith` is not provided. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + ReplaceKeyWith: + $ref: '#/components/schemas/ReplaceKeyWith' + description: 'The specific object key to use in the redirect request. For + example, redirect request to `error.html`. Not required if one of the + siblings is present. Can be present only if `ReplaceKeyPrefixWith` is + not provided. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + description: Specifies how requests are redirected. In the event of an error, + you can specify a different error code to return. + RedirectAllRequestsTo: + type: object + properties: + HostName: + $ref: '#/components/schemas/HostName' + description: Name of the host where requests are redirected. + Protocol: + $ref: '#/components/schemas/Protocol' + description: Protocol to use when redirecting requests. The default is the + protocol that is used in the original request. + required: + - HostName + description: Specifies the redirect behavior of all requests to a website endpoint + of an Amazon S3 bucket. + Region: + type: string + minLength: 0 + maxLength: 20 + RenameObjectOutput: + type: object + properties: {} + RenameObjectRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket name of the directory bucket containing the object. + + + You must use virtual-hosted-style requests in the format `Bucket-name.s3express-zone-id.region-code.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--zone-id--x-s3 ` (for example, `amzn-s3-demo-bucket--usw2-az1--x-s3`). + For information about bucket naming restrictions, see [Directory bucket + naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Key name of the object to rename. + RenameSource: + $ref: '#/components/schemas/RenameSource' + description: Specifies the source for the rename operation. The value must + be URL encoded. + DestinationIfMatch: + $ref: '#/components/schemas/IfMatch' + description: 'Renames the object only if the ETag (entity tag) value provided + during the operation matches the ETag of the object in S3. The `If-Match` + header field makes the request method conditional on ETags. If the ETag + values do not match, the operation returns a `412 Precondition Failed` + error. + + + Expects the ETag value as a string.' + DestinationIfNoneMatch: + $ref: '#/components/schemas/IfNoneMatch' + description: 'Renames the object only if the destination does not already + exist in the specified directory bucket. If the object does exist when + you send a request with `If-None-Match:*`, the S3 API will return a `412 + Precondition Failed` error, preventing an overwrite. The `If-None-Match` + header prevents overwrites of existing data by validating that there''s + not an object with the same key name already in your directory bucket. + + + Expects the `*` character (asterisk).' + DestinationIfModifiedSince: + $ref: '#/components/schemas/IfModifiedSince' + description: Renames the object if the destination exists and if it has + been modified since the specified time. + DestinationIfUnmodifiedSince: + $ref: '#/components/schemas/IfUnmodifiedSince' + description: Renames the object if it hasn't been modified since the specified + time. + SourceIfMatch: + $ref: '#/components/schemas/RenameSourceIfMatch' + description: Renames the object if the source exists and if its entity tag + (ETag) matches the specified ETag. + SourceIfNoneMatch: + $ref: '#/components/schemas/RenameSourceIfNoneMatch' + description: Renames the object if the source exists and if its entity tag + (ETag) is different than the specified ETag. If an asterisk (`*`) character + is provided, the operation will fail and return a `412 Precondition Failed` + error. + SourceIfModifiedSince: + $ref: '#/components/schemas/RenameSourceIfModifiedSince' + description: Renames the object if the source exists and if it has been + modified since the specified time. + SourceIfUnmodifiedSince: + $ref: '#/components/schemas/RenameSourceIfUnmodifiedSince' + description: Renames the object if the source exists and hasn't been modified + since the specified time. + ClientToken: + $ref: '#/components/schemas/ClientToken' + description: 'A unique string with a max of 64 ASCII characters in the ASCII + range of 33 - 126. + + + `RenameObject` supports idempotency using a client token. To make an idempotent + API request using `RenameObject`, specify a client token in the request. + You should not reuse the same client token for other API requests. If + you retry a request that completed successfully using the same client + token and the same parameters, the retry succeeds without performing any + further actions. If you retry a successful request using the same client + token, but one or more of the parameters are different, the retry fails + and an `IdempotentParameterMismatch` error is returned.' + required: + - Bucket + - Key + - RenameSource + RenameSource: + type: string + pattern: ^\/?.+\/.+$ + RenameSourceIfMatch: + type: string + RenameSourceIfModifiedSince: + type: string + format: date-time + RenameSourceIfNoneMatch: + type: string + RenameSourceIfUnmodifiedSince: + type: string + format: date-time + ReplaceKeyPrefixWith: + type: string + ReplaceKeyWith: + type: string + ReplicaKmsKeyID: + type: string + ReplicaModifications: + type: object + properties: + Status: + $ref: '#/components/schemas/ReplicaModificationsStatus' + description: Specifies whether Amazon S3 replicates modifications on replicas. + required: + - Status + description: 'A filter that you can specify for selection for modifications + on replicas. Amazon S3 doesn''t replicate replica modifications by default. + In the latest version of replication configuration (when `Filter` is specified), + you can specify this element and set the status to `Enabled` to replicate + modifications on replicas. + + + If you don''t specify the `Filter` element, Amazon S3 assumes that the replication + configuration is the earlier version, V1. In the earlier version, this element + is not allowed.' + ReplicaModificationsStatus: + type: string + enum: + - Enabled + - Disabled + ReplicationConfiguration: + type: object + properties: + Role: + $ref: '#/components/schemas/Role' + description: The Amazon Resource Name (ARN) of the Identity and Access Management + (IAM) role that Amazon S3 assumes when replicating objects. For more information, + see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) + in the _Amazon S3 User Guide_. + Rules: + $ref: '#/components/schemas/ReplicationRules' + description: A container for one or more replication rules. A replication + configuration must have at least one rule and can contain a maximum of + 1,000 rules. + required: + - Role + - Rules + description: A container for replication rules. You can add up to 1,000 rules. + The maximum size of a replication configuration is 2 MB. + ReplicationRule: + type: object + properties: + ID: + $ref: '#/components/schemas/ID' + description: A unique identifier for the rule. The maximum value is 255 + characters. + Priority: + $ref: '#/components/schemas/Priority' + description: 'The priority indicates which rule has precedence whenever + two or more replication rules conflict. Amazon S3 will attempt to replicate + objects according to all replication rules. However, if there are two + or more rules with the same destination bucket, then objects will be replicated + according to the rule with the highest priority. The higher the number, + the higher the priority. + + + For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) + in the _Amazon S3 User Guide_.' + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'An object key name prefix that identifies the object or objects + to which the rule applies. The maximum prefix length is 1,024 characters. + To include all objects in a bucket, specify an empty string. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + Filter: + $ref: '#/components/schemas/ReplicationRuleFilter' + Status: + $ref: '#/components/schemas/ReplicationRuleStatus' + description: Specifies whether the rule is enabled. + SourceSelectionCriteria: + $ref: '#/components/schemas/SourceSelectionCriteria' + description: A container that describes additional filters for identifying + the source objects that you want to replicate. You can choose to enable + or disable the replication of these objects. Currently, Amazon S3 supports + only the filter that you can specify for objects created with server-side + encryption using a customer managed key stored in Amazon Web Services + Key Management Service (SSE-KMS). + ExistingObjectReplication: + $ref: '#/components/schemas/ExistingObjectReplication' + description: 'Optional configuration to replicate existing source bucket + objects. + + + This parameter is no longer supported. To replicate existing objects, + see [Replicating existing objects with S3 Batch Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html) + in the _Amazon S3 User Guide_.' + Destination: + $ref: '#/components/schemas/Destination' + description: A container for information about the replication destination + and its configurations including enabling the S3 Replication Time Control + (S3 RTC). + DeleteMarkerReplication: + $ref: '#/components/schemas/DeleteMarkerReplication' + required: + - Status + - Destination + description: Specifies which Amazon S3 objects to replicate and where to store + the replicas. + ReplicationRuleAndOperator: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: An object key name prefix that identifies the subset of objects + to which the rule applies. + Tags: + $ref: '#/components/schemas/TagSet' + description: An array of tags containing key and value pairs. + description: "A container for specifying rule filters. The filters determine\ + \ the subset of objects to which the rule applies. This element is required\ + \ only if you specify more than one filter.\n\nFor example:\n\n * If you\ + \ specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And`\ + \ tag. \n\n * If you specify a filter based on multiple tags, wrap the `Tag`\ + \ elements in an `And` tag." + ReplicationRuleFilter: + type: object + properties: + Prefix: + $ref: '#/components/schemas/Prefix' + description: 'An object key name prefix that identifies the subset of objects + to which the rule applies. + + + Replacement must be made for object keys containing special characters + (such as carriage returns) when using XML requests. For more information, + see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).' + Tag: + $ref: '#/components/schemas/Tag' + description: 'A container for specifying a tag key and value. + + + The rule applies only to objects that have the tag in their tag set.' + And: + $ref: '#/components/schemas/ReplicationRuleAndOperator' + description: "A container for specifying rule filters. The filters determine\ + \ the subset of objects to which the rule applies. This element is required\ + \ only if you specify more than one filter. For example:\n\n * If you\ + \ specify both a `Prefix` and a `Tag` filter, wrap these filters in an\ + \ `And` tag.\n\n * If you specify a filter based on multiple tags, wrap\ + \ the `Tag` elements in an `And` tag." + description: A filter that identifies the subset of objects to which the replication + rule applies. A `Filter` must specify exactly one `Prefix`, `Tag`, or an `And` + child element. + ReplicationRuleStatus: + type: string + enum: + - Enabled + - Disabled + ReplicationRules: + type: array + items: + $ref: '#/components/schemas/ReplicationRule' + ReplicationStatus: + type: string + enum: + - COMPLETE + - PENDING + - FAILED + - REPLICA + - COMPLETED + ReplicationTime: + type: object + properties: + Status: + $ref: '#/components/schemas/ReplicationTimeStatus' + description: Specifies whether the replication time is enabled. + Time: + $ref: '#/components/schemas/ReplicationTimeValue' + description: A container specifying the time by which replication should + be complete for all objects and operations on objects. + required: + - Status + - Time + description: A container specifying S3 Replication Time Control (S3 RTC) related + information, including whether S3 RTC is enabled and the time when all objects + and operations on objects must be replicated. Must be specified together with + a `Metrics` block. + ReplicationTimeStatus: + type: string + enum: + - Enabled + - Disabled + ReplicationTimeValue: + type: object + properties: + Minutes: + $ref: '#/components/schemas/Minutes' + description: 'Contains an integer specifying time in minutes. + + + Valid value: 15' + description: A container specifying the time value for S3 Replication Time Control + (S3 RTC) and replication metrics `EventThreshold`. + RequestCharged: + type: string + enum: + - requester + description: "

If present, indicates that the requester was successfully charged\ + \ for the request. For more\n information, see Using Requester Pays buckets for storage transfers and usage in the Amazon\ + \ Simple\n Storage Service user guide.

\n \n \ + \

This functionality is not supported for directory buckets.

\n\ + \ " + RequestPayer: + type: string + enum: + - requester + description: "

Confirms that the requester knows that they will be charged\ + \ for the request. Bucket owners need not\n specify this parameter in\ + \ their requests. If either the source or destination S3 bucket has Requester\n\ + \ Pays enabled, the requester will pay for corresponding charges to copy\ + \ the object. For information about\n downloading objects from Requester\ + \ Pays buckets, see Downloading Objects in Requester Pays\n Buckets in the Amazon\ + \ S3 User Guide.

\n \n

This functionality\ + \ is not supported for directory buckets.

\n " + RequestPaymentConfiguration: + type: object + properties: + Payer: + $ref: '#/components/schemas/Payer' + description: Specifies who pays for the download and request fees. + required: + - Payer + description: Container for Payer. + RequestProgress: + type: object + properties: + Enabled: + $ref: '#/components/schemas/EnableRequestProgress' + description: 'Specifies whether periodic QueryProgress frames should be + sent. Valid values: TRUE, FALSE. Default value: FALSE.' + description: Container for specifying if periodic `QueryProgress` messages should + be sent. + RequestRoute: + type: string + RequestToken: + type: string + ResponseCacheControl: + type: string + ResponseContentDisposition: + type: string + ResponseContentEncoding: + type: string + ResponseContentLanguage: + type: string + ResponseContentType: + type: string + ResponseExpires: + type: string + format: date-time + Restore: + type: string + RestoreExpiryDate: + type: string + format: date-time + RestoreObjectOutput: + type: object + properties: + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + RestoreOutputPath: + $ref: '#/components/schemas/RestoreOutputPath' + description: Indicates the path in the provided S3 output location where + Select results will be restored to. + RestoreObjectRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: 'The bucket name containing the object to restore. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the action was initiated. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: VersionId used to reference a specific version of the object. + RestoreRequest: + $ref: '#/components/schemas/RestoreRequest' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + If you provide an individual checksum, Amazon S3 ignores any provided + `ChecksumAlgorithm` parameter.' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + RestoreOutputPath: + type: string + RestoreRequest: + type: object + properties: + Days: + $ref: '#/components/schemas/Days' + description: 'Lifetime of the active copy in days. Do not use with restores + that specify `OutputLocation`. + + + The Days element is required for regular restores, and must not be provided + for select requests.' + GlacierJobParameters: + $ref: '#/components/schemas/GlacierJobParameters' + description: S3 Glacier related parameters pertaining to this job. Do not + use with restores that specify `OutputLocation`. + Type: + $ref: '#/components/schemas/RestoreRequestType' + description: 'Amazon S3 Select is no longer available to new customers. + Existing customers of Amazon S3 Select can continue to use the feature + as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) + + + Type of restore request.' + Tier: + $ref: '#/components/schemas/Tier' + description: Retrieval tier at which the restore will be processed. + Description: + $ref: '#/components/schemas/Description' + description: The optional description for the job. + SelectParameters: + $ref: '#/components/schemas/SelectParameters' + description: 'Amazon S3 Select is no longer available to new customers. + Existing customers of Amazon S3 Select can continue to use the feature + as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) + + + Describes the parameters for Select job types.' + OutputLocation: + $ref: '#/components/schemas/OutputLocation' + description: Describes the location where the restore job's output is stored. + description: Container for restore job parameters. + RestoreRequestType: + type: string + enum: + - SELECT + RestoreStatus: + type: object + properties: + IsRestoreInProgress: + $ref: '#/components/schemas/IsRestoreInProgress' + description: 'Specifies whether the object is currently being restored. + If the object restoration is in progress, the header returns the value + `TRUE`. For example: + + + `x-amz-optional-object-attributes: IsRestoreInProgress="true"` + + + If the object restoration has completed, the header returns the value + `FALSE`. For example: + + + `x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"` + + + If the object hasn''t been restored, there is no header response.' + RestoreExpiryDate: + $ref: '#/components/schemas/RestoreExpiryDate' + description: '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"`' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) + in the _Amazon S3 User Guide_. + + + This functionality is not supported for directory buckets. Directory buckets + only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in + Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage + class) in Dedicated Local Zones.' + Role: + type: string + RoutingRule: + type: object + properties: + Condition: + $ref: '#/components/schemas/Condition' + description: A container for describing a condition that must be met for + the specified redirect to apply. For example, 1. If request is for pages + in the `/docs` folder, redirect to the `/documents` folder. 2. If request + results in HTTP error 4xx, redirect request to another host where you + might process the error. + Redirect: + $ref: '#/components/schemas/Redirect' + description: Container for redirect information. You can redirect requests + to another host, to another page, or with another protocol. In the event + of an error, you can specify a different error code to return. + required: + - Redirect + description: Specifies the redirect behavior and when a redirect is applied. + For more information about routing rules, see [Configuring advanced conditional + redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) + in the _Amazon S3 User Guide_. + RoutingRules: + type: array + items: + $ref: '#/components/schemas/RoutingRule' + S3KeyFilter: + type: object + properties: + FilterRules: + $ref: '#/components/schemas/FilterRuleList' + description: A container for object key name prefix and suffix filtering rules. + S3Location: + type: object + properties: + BucketName: + $ref: '#/components/schemas/BucketName' + description: The name of the bucket where the restore results will be placed. + Prefix: + $ref: '#/components/schemas/LocationPrefix' + description: The prefix that is prepended to the restore results for this + request. + Encryption: + $ref: '#/components/schemas/Encryption' + CannedACL: + $ref: '#/components/schemas/ObjectCannedACL' + description: The canned ACL to apply to the restore results. + AccessControlList: + $ref: '#/components/schemas/Grants' + description: A list of grants that control access to the staged results. + Tagging: + $ref: '#/components/schemas/Tagging' + description: The tag-set that is applied to the restore results. + UserMetadata: + $ref: '#/components/schemas/UserMetadata' + description: A list of metadata to store with the restore results in S3. + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: The class of storage used to store the restore results. + required: + - BucketName + - Prefix + description: Describes an Amazon S3 location that will receive the results of + the restore request. + S3RegionalOrS3ExpressBucketArnString: + type: string + pattern: '^arn:[^:]+:(s3|s3express):' + minLength: 1 + maxLength: 128 + S3TablesArn: + type: string + S3TablesBucketArn: + type: string + S3TablesBucketType: + type: string + enum: + - aws + - customer + S3TablesDestination: + type: object + properties: + TableBucketArn: + $ref: '#/components/schemas/S3TablesBucketArn' + description: The Amazon Resource Name (ARN) for the table bucket that's + specified as the destination in the metadata table configuration. The + destination table bucket must be in the same Region and Amazon Web Services + account as the general purpose bucket. + TableName: + $ref: '#/components/schemas/S3TablesName' + description: The name for the metadata table in your metadata table configuration. + The specified metadata table name must be unique within the `aws_s3_metadata` + namespace in the destination table bucket. + required: + - TableBucketArn + - TableName + description: 'The destination information for a V1 S3 Metadata configuration. + The destination table bucket must be in the same Region and Amazon Web Services + account as the general purpose bucket. The specified metadata table name must + be unique within the `aws_s3_metadata` namespace in the destination table + bucket. + + + If you created your S3 Metadata configuration before July 15, 2025, we recommend + that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) + so that you can expire journal table records and create a live inventory table.' + S3TablesDestinationResult: + type: object + properties: + TableBucketArn: + $ref: '#/components/schemas/S3TablesBucketArn' + description: The Amazon Resource Name (ARN) for the table bucket that's + specified as the destination in the metadata table configuration. The + destination table bucket must be in the same Region and Amazon Web Services + account as the general purpose bucket. + TableName: + $ref: '#/components/schemas/S3TablesName' + description: The name for the metadata table in your metadata table configuration. + The specified metadata table name must be unique within the `aws_s3_metadata` + namespace in the destination table bucket. + TableArn: + $ref: '#/components/schemas/S3TablesArn' + description: The Amazon Resource Name (ARN) for the metadata table in the + metadata table configuration. The specified metadata table name must be + unique within the `aws_s3_metadata` namespace in the destination table + bucket. + TableNamespace: + $ref: '#/components/schemas/S3TablesNamespace' + description: The table bucket namespace for the metadata table in your metadata + table configuration. This value is always `aws_s3_metadata`. + required: + - TableBucketArn + - TableName + - TableArn + - TableNamespace + description: 'The destination information for a V1 S3 Metadata configuration. + The destination table bucket must be in the same Region and Amazon Web Services + account as the general purpose bucket. The specified metadata table name must + be unique within the `aws_s3_metadata` namespace in the destination table + bucket. + + + If you created your S3 Metadata configuration before July 15, 2025, we recommend + that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) + so that you can expire journal table records and create a live inventory table.' + S3TablesName: + type: string + S3TablesNamespace: + type: string + SSECustomerAlgorithm: + type: string + SSECustomerKey: + type: string + SSECustomerKeyMD5: + type: string + SSEKMS: + type: object + properties: + KeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: Specifies the ID of the Key Management Service (KMS) symmetric + encryption customer managed key to use for encrypting inventory reports. + required: + - KeyId + description: Specifies the use of SSE-KMS to encrypt delivered inventory reports. + SSEKMSEncryptionContext: + type: string + SSEKMSKeyId: + type: string + SSES3: + type: object + properties: {} + description: Specifies the use of SSE-S3 to encrypt delivered inventory reports. + ScanRange: + type: object + properties: + Start: + $ref: '#/components/schemas/Start' + description: 'Specifies the start of the byte range. This parameter is optional. + Valid values: non-negative integers. The default value is 0. If only `start` + is supplied, it means scan from that point to the end of the file. For + example, `50` means scan from byte 50 until the end of the file.' + End: + $ref: '#/components/schemas/End' + description: 'Specifies the end of the byte range. This parameter is optional. + Valid values: non-negative integers. The default value is one less than + the size of the object being queried. If only the End parameter is supplied, + it is interpreted to mean scan the last N bytes of the file. For example, + `50` means scan the last 50 bytes.' + description: Specifies the byte range of the object to get the records from. + A record is processed when its first byte is contained by the range. This + parameter is optional, but when specified, it must not be empty. See RFC 2616, + Section 14.35.1 about how to specify the start and end of the range. + SelectObjectContentEventStream: + allOf: + - $ref: '#/components/schemas/RecordsEvent' + description: |- + The Records Event. + - $ref: '#/components/schemas/StatsEvent' + description: |- + The Stats Event. + - $ref: '#/components/schemas/ProgressEvent' + description: |- + The Progress Event. + - $ref: '#/components/schemas/ContinuationEvent' + description: |- + The Continuation Event. + - $ref: '#/components/schemas/EndEvent' + description: |- + The End Event. + description: |- + The container for selecting objects from a content event stream. + SelectObjectContentOutput: + type: object + properties: + Payload: + $ref: '#/components/schemas/SelectObjectContentEventStream' + description: The array of results. + SelectObjectContentRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The S3 bucket. + Key: + $ref: '#/components/schemas/ObjectKey' + description: The object key. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + in the _Amazon S3 User Guide_. + Expression: + $ref: '#/components/schemas/Expression' + description: The expression that is used to query the object. + ExpressionType: + $ref: '#/components/schemas/ExpressionType' + description: The type of the provided expression (for example, SQL). + RequestProgress: + $ref: '#/components/schemas/RequestProgress' + description: Specifies if periodic request progress information should be + enabled. + InputSerialization: + $ref: '#/components/schemas/InputSerialization' + description: Describes the format of the data in the object that is being + queried. + OutputSerialization: + $ref: '#/components/schemas/OutputSerialization' + description: Describes the format of the data that you want Amazon S3 to + return in response. + ScanRange: + $ref: '#/components/schemas/ScanRange' + description: "Specifies the byte range of the object to get the records\ + \ from. A record is processed when its first byte is contained by the\ + \ range. This parameter is optional, but when specified, it must not be\ + \ empty. See RFC 2616, Section 14.35.1 about how to specify the start\ + \ and end of the range.\n\n`ScanRange`may be used in the following ways:\n\ + \n * `50100` \\- process only the records starting between the bytes\ + \ 50 and 100 (inclusive, counting from zero)\n\n * `50` \\- process only\ + \ the records starting after the byte 50\n\n * `50` \\- process only\ + \ the records within the last 50 bytes of the file." + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + - Expression + - ExpressionType + - InputSerialization + - OutputSerialization + description: 'Learn Amazon S3 Select is no longer available to new customers. + Existing customers of Amazon S3 Select can continue to use the feature as + usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) + + + Request to filter 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 specify a data serialization format (JSON or CSV) of the object. + Amazon S3 uses this to parse object data into records. It returns only records + that match the specified SQL expression. You must also specify the data serialization + format for the response. For more information, see [S3Select API Documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html).' + SelectParameters: + type: object + properties: + InputSerialization: + $ref: '#/components/schemas/InputSerialization' + description: Describes the serialization format of the object. + ExpressionType: + $ref: '#/components/schemas/ExpressionType' + description: The type of the provided expression (for example, SQL). + Expression: + $ref: '#/components/schemas/Expression' + description: 'Amazon S3 Select is no longer available to new customers. + Existing customers of Amazon S3 Select can continue to use the feature + as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) + + + The expression that is used to query the object.' + OutputSerialization: + $ref: '#/components/schemas/OutputSerialization' + description: Describes how the results of the Select job are serialized. + required: + - InputSerialization + - ExpressionType + - Expression + - OutputSerialization + description: 'Amazon S3 Select is no longer available to new customers. Existing + customers of Amazon S3 Select can continue to use the feature as usual. [Learn + more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) + + + Describes the parameters for Select job types. + + + Learn [How to optimize querying your data in Amazon S3](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) + using [Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/what-is.html), + [S3 Object Lambda](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html), + or client-side filtering.' + ServerSideEncryption: + type: string + enum: + - AES256 + - aws:fsx + - aws:kms + - aws:kms:dsse + ServerSideEncryptionByDefault: + type: object + properties: + SSEAlgorithm: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'Server-side encryption algorithm to use for the default encryption. + + + For directory buckets, there are only two supported values for server-side + encryption: `AES256` and `aws:kms`.' + KMSMasterKeyID: + $ref: '#/components/schemas/SSEKMSKeyId' + description: "Amazon Web Services Key Management Service (KMS) customer\ + \ managed key ID to use for the default encryption.\n\n * **General purpose\ + \ buckets** \\- This parameter is allowed if and only if `SSEAlgorithm`\ + \ is set to `aws:kms` or `aws:kms:dsse`.\n\n * **Directory buckets**\ + \ \\- This parameter is allowed if and only if `SSEAlgorithm` is set to\ + \ `aws:kms`.\n\nYou can specify the key ID, key alias, or the Amazon Resource\ + \ Name (ARN) of the KMS key.\n\n * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n\ + \n * Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n\ + \n * Key Alias: `alias/alias-name`\n\nIf you are using encryption with\ + \ cross-account or Amazon Web Services service operations, you must use\ + \ a fully qualified KMS key ARN. For more information, see [Using encryption\ + \ for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n\ + \n * **General purpose buckets** \\- If you're specifying a customer\ + \ managed KMS key, we recommend using a fully qualified KMS key ARN. If\ + \ you use a KMS key alias instead, then KMS resolves the key within the\ + \ requester’s account. This behavior can result in data that's encrypted\ + \ with a KMS key that belongs to the requester, and not the bucket owner.\ + \ Also, if you use a key ID, you can run into a LogDestination undeliverable\ + \ error when creating a VPC flow log. \n\n * **Directory buckets** \\\ + - When you specify an [KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ + \ for encryption in your directory bucket, only use the key ID or key\ + \ ARN. The key alias format of the KMS key isn't supported.\n\nAmazon\ + \ S3 only supports symmetric encryption KMS keys. For more information,\ + \ see [Asymmetric keys in Amazon Web Services KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)\ + \ in the _Amazon Web Services Key Management Service Developer Guide_." + required: + - SSEAlgorithm + description: "Describes the default server-side encryption to apply to new objects\ + \ in the bucket. If a PUT Object request doesn't specify any server-side encryption,\ + \ this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html).\n\ + \n * **General purpose buckets** \\- If you don't specify a customer managed\ + \ key at configuration, Amazon S3 automatically creates an Amazon Web Services\ + \ KMS key (`aws/s3`) in your Amazon Web Services account the first time that\ + \ you add an object encrypted with SSE-KMS to a bucket. By default, Amazon\ + \ S3 uses this KMS key for SSE-KMS. \n\n * **Directory buckets** \\- Your\ + \ SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ + \ per directory bucket's lifetime. The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\ + \ (`aws/s3`) isn't supported. \n\n * **Directory buckets** \\- For directory\ + \ buckets, there are only two supported options for server-side encryption:\ + \ SSE-S3 and SSE-KMS." + ServerSideEncryptionConfiguration: + type: object + properties: + Rules: + $ref: '#/components/schemas/ServerSideEncryptionRules' + description: Container for information about a particular server-side encryption + configuration rule. + required: + - Rules + description: Specifies the default server-side-encryption configuration. + ServerSideEncryptionRule: + type: object + properties: + ApplyServerSideEncryptionByDefault: + $ref: '#/components/schemas/ServerSideEncryptionByDefault' + description: Specifies the default server-side encryption to apply to new + objects in the bucket. If a PUT Object request doesn't specify any server-side + encryption, this default encryption will be applied. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: "Specifies whether Amazon S3 should use an S3 Bucket Key with\ + \ server-side encryption using KMS (SSE-KMS) for new objects in the bucket.\ + \ Existing objects are not affected. Setting the `BucketKeyEnabled` element\ + \ to `true` causes Amazon S3 to use an S3 Bucket Key.\n\n * **General\ + \ purpose buckets** \\- By default, S3 Bucket Key is not enabled. For\ + \ more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html)\ + \ in the _Amazon S3 User Guide_.\n\n * **Directory buckets** \\- S3 Bucket\ + \ Keys are always enabled for `GET` and `PUT` operations in a directory\ + \ bucket and can’t be disabled. S3 Bucket Keys aren't supported, when\ + \ you copy SSE-KMS encrypted objects from general purpose buckets to directory\ + \ buckets, from directory buckets to general purpose buckets, or between\ + \ directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html),\ + \ [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html),\ + \ [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops),\ + \ or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job).\ + \ In this case, Amazon S3 makes a call to KMS every time a copy request\ + \ is made for a KMS-encrypted object." + BlockedEncryptionTypes: + $ref: '#/components/schemas/BlockedEncryptionTypes' + description: 'A bucket-level setting for Amazon S3 general purpose buckets + used to prevent the upload of new objects encrypted with the specified + server-side encryption type. For example, blocking an encryption type + will block `PutObject`, `CopyObject`, `PostObject`, multipart upload, + and replication requests to the bucket for objects with the specified + encryption type. However, you can continue to read and list any pre-existing + objects already encrypted with the specified encryption type. For more + information, see [Blocking or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html). + + + Currently, this parameter only supports blocking or unblocking server-side + encryption with customer-provided keys (SSE-C). For more information about + SSE-C, see [Using server-side encryption with customer-provided keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).' + description: "Specifies the default server-side encryption configuration.\n\n\ + \ * **General purpose buckets** \\- If you're specifying a customer managed\ + \ KMS key, we recommend using a fully qualified KMS key ARN. If you use a\ + \ KMS key alias instead, then KMS resolves the key within the requester’s\ + \ account. This behavior can result in data that's encrypted with a KMS key\ + \ that belongs to the requester, and not the bucket owner.\n\n * **Directory\ + \ buckets** \\- When you specify an [KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\ + \ for encryption in your directory bucket, only use the key ID or key ARN.\ + \ The key alias format of the KMS key isn't supported." + ServerSideEncryptionRules: + type: array + items: + $ref: '#/components/schemas/ServerSideEncryptionRule' + SessionCredentialValue: + type: string + SessionCredentials: + type: object + properties: + AccessKeyId: + $ref: '#/components/schemas/AccessKeyIdValue' + description: 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. + SecretAccessKey: + $ref: '#/components/schemas/SessionCredentialValue' + description: 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. + SessionToken: + $ref: '#/components/schemas/SessionCredentialValue' + description: A part of the temporary security credentials. The session token + is used to validate the temporary security credentials. + Expiration: + $ref: '#/components/schemas/SessionExpiration' + description: 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. + required: + - AccessKeyId + - SecretAccessKey + - SessionToken + - Expiration + description: 'The established temporary security credentials of the session. + + + **Directory buckets** \- These session credentials are only supported for + the authentication and authorization of Zonal endpoint API operations on directory + buckets.' + SessionExpiration: + type: string + format: date-time + SessionMode: + type: string + enum: + - ReadOnly + - ReadWrite + Setting: + type: boolean + SimplePrefix: + type: object + properties: {} + description: 'To use simple format for S3 keys for log objects, set SimplePrefix + to an empty object. + + + `[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`' + Size: + type: integer + format: int64 + SkipValidation: + type: boolean + SourceSelectionCriteria: + type: object + properties: + SseKmsEncryptedObjects: + $ref: '#/components/schemas/SseKmsEncryptedObjects' + description: A container for filter information for the selection of Amazon + S3 objects encrypted with Amazon Web Services KMS. If you include `SourceSelectionCriteria` + in the replication configuration, this element is required. + ReplicaModifications: + $ref: '#/components/schemas/ReplicaModifications' + description: 'A filter that you can specify for selections for modifications + on replicas. Amazon S3 doesn''t replicate replica modifications by default. + In the latest version of replication configuration (when `Filter` is specified), + you can specify this element and set the status to `Enabled` to replicate + modifications on replicas. + + + If you don''t specify the `Filter` element, Amazon S3 assumes that the + replication configuration is the earlier version, V1. In the earlier version, + this element is not allowed' + description: A container that describes additional filters for identifying the + source objects that you want to replicate. You can choose to enable or disable + the replication of these objects. Currently, Amazon S3 supports only the filter + that you can specify for objects created with server-side encryption using + a customer managed key stored in Amazon Web Services Key Management Service + (SSE-KMS). + SseKmsEncryptedObjects: + type: object + properties: + Status: + $ref: '#/components/schemas/SseKmsEncryptedObjectsStatus' + description: Specifies whether Amazon S3 replicates objects created with + server-side encryption using an Amazon Web Services KMS key stored in + Amazon Web Services Key Management Service. + required: + - Status + description: A container for filter information for the selection of S3 objects + encrypted with Amazon Web Services KMS. + SseKmsEncryptedObjectsStatus: + type: string + enum: + - Enabled + - Disabled + Start: + type: integer + format: int64 + StartAfter: + type: string + Stats: + type: object + properties: + BytesScanned: + $ref: '#/components/schemas/BytesScanned' + description: The total number of object bytes scanned. + BytesProcessed: + $ref: '#/components/schemas/BytesProcessed' + description: The total number of uncompressed object bytes processed. + BytesReturned: + $ref: '#/components/schemas/BytesReturned' + description: The total number of bytes of records payload data returned. + description: Container for the stats details. + StatsEvent: + type: object + properties: + Details: + $ref: '#/components/schemas/Stats' + description: The Stats event details. + description: Container for the Stats Event. + StorageClass: + type: string + enum: + - STANDARD + - REDUCED_REDUNDANCY + - STANDARD_IA + - ONEZONE_IA + - INTELLIGENT_TIERING + - GLACIER + - DEEP_ARCHIVE + - OUTPOSTS + - GLACIER_IR + - SNOW + - EXPRESS_ONEZONE + - FSX_OPENZFS + - FSX_ONTAP + StorageClassAnalysis: + type: object + properties: + DataExport: + $ref: '#/components/schemas/StorageClassAnalysisDataExport' + description: Specifies how data related to the storage class analysis for + an Amazon S3 bucket should be exported. + description: Specifies data related to access patterns to be collected and made + available to analyze the tradeoffs between different storage classes for an + Amazon S3 bucket. + StorageClassAnalysisDataExport: + type: object + properties: + OutputSchemaVersion: + $ref: '#/components/schemas/StorageClassAnalysisSchemaVersion' + description: The version of the output schema to use when exporting data. + Must be `V_1`. + Destination: + $ref: '#/components/schemas/AnalyticsExportDestination' + description: The place to store the data for an analysis. + required: + - OutputSchemaVersion + - Destination + description: Container for data related to the storage class analysis for an + Amazon S3 bucket for export. + StorageClassAnalysisSchemaVersion: + type: string + enum: + - V_1 + StreamingBlob: + type: string + format: byte + Suffix: + type: string + TableSseAlgorithm: + type: string + enum: + - aws:kms + - AES256 + Tag: + type: object + properties: + Key: + $ref: '#/components/schemas/ObjectKey' + description: Name of the object key. + Value: + $ref: '#/components/schemas/Value' + description: Value of the tag. + required: + - Key + - Value + description: A container of a key value name pair. + TagCount: + type: integer + TagSet: + type: array + items: + $ref: '#/components/schemas/Tag' + Tagging: + type: object + properties: + TagSet: + $ref: '#/components/schemas/TagSet' + description: A collection for a set of tags + required: + - TagSet + description: Container for `TagSet` elements. + TaggingDirective: + type: string + enum: + - COPY + - REPLACE + TaggingHeader: + type: string + TargetBucket: + type: string + TargetGrant: + type: object + properties: + Grantee: + $ref: '#/components/schemas/Grantee' + description: Container for the person being granted permissions. + Permission: + $ref: '#/components/schemas/BucketLogsPermission' + description: Logging permissions assigned to the grantee for the bucket. + description: 'Container for granting information. + + + Buckets that use the bucket owner enforced setting for Object Ownership don''t + support target grants. For more information, see [Permissions server access + log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) + in the _Amazon S3 User Guide_.' + TargetGrants: + type: array + items: + $ref: '#/components/schemas/TargetGrant' + TargetObjectKeyFormat: + type: object + properties: + SimplePrefix: + $ref: '#/components/schemas/SimplePrefix' + description: To use the simple format for S3 keys for log objects. To specify + SimplePrefix format, set SimplePrefix to {}. + PartitionedPrefix: + $ref: '#/components/schemas/PartitionedPrefix' + description: Partitioned S3 key for log objects. + description: Amazon S3 key format for log objects. Only one format, PartitionedPrefix + or SimplePrefix, is allowed. + TargetPrefix: + type: string + Tier: + type: string + enum: + - Standard + - Bulk + - Expedited + Tiering: + type: object + properties: + Days: + $ref: '#/components/schemas/IntelligentTieringDays' + description: The number of consecutive days of no access after which an + object will be eligible to be transitioned to the corresponding tier. + The minimum number of days specified for Archive Access tier must be at + least 90 days and Deep Archive Access tier must be at least 180 days. + The maximum can be up to 2 years (730 days). + AccessTier: + $ref: '#/components/schemas/IntelligentTieringAccessTier' + description: S3 Intelligent-Tiering access tier. See [Storage class for + automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) + for a list of access tiers in the S3 Intelligent-Tiering storage class. + required: + - Days + - AccessTier + description: 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 additional operational overhead. + TieringList: + type: array + items: + $ref: '#/components/schemas/Tiering' + Token: + type: string + TooManyParts: + type: object + properties: {} + description: You have attempted to add more parts than the maximum of 10000 + that are allowed for this object. You can use the CopyObject operation to + copy this object to another and then add more data to the newly copied object. + TopicArn: + type: string + TopicConfiguration: + type: object + properties: + Id: + $ref: '#/components/schemas/NotificationId' + TopicArn: + $ref: '#/components/schemas/TopicArn' + description: The Amazon Resource Name (ARN) of the Amazon SNS topic to which + Amazon S3 publishes a message when it detects events of the specified + type. + Events: + $ref: '#/components/schemas/EventList' + description: The Amazon S3 bucket event about which to send notifications. + For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + in the _Amazon S3 User Guide_. + Filter: + $ref: '#/components/schemas/NotificationConfigurationFilter' + required: + - TopicArn + - Events + description: A container for specifying the configuration for publication of + messages to an Amazon Simple Notification Service (Amazon SNS) topic when + Amazon S3 detects specified events. + TopicConfigurationList: + type: array + items: + $ref: '#/components/schemas/TopicConfiguration' + Transition: + type: object + properties: + Date: + $ref: '#/components/schemas/Date' + description: Indicates when objects are transitioned to the specified storage + class. The date value must be in ISO 8601 format. The time is always midnight + UTC. + Days: + $ref: '#/components/schemas/Days' + description: Indicates the number of days after creation when objects are + transitioned to the specified storage class. If the specified storage + class is `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE`, + valid values are `0` or positive integers. If the specified storage class + is `STANDARD_IA` or `ONEZONE_IA`, valid values are positive integers greater + than `30`. Be aware that some storage classes have a minimum storage duration + and that you're charged for transitioning objects before their minimum + storage duration. For more information, see [ Constraints and considerations + for transitions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-transition-general-considerations.html#lifecycle-configuration-constraints) + in the _Amazon S3 User Guide_. + StorageClass: + $ref: '#/components/schemas/TransitionStorageClass' + description: The storage class to which you want the object to transition. + description: Specifies when an object transitions to a specified storage class. + For more information about Amazon S3 lifecycle configuration rules, see [Transitioning + Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) + in the _Amazon S3 User Guide_. + TransitionDefaultMinimumObjectSize: + type: string + enum: + - varies_by_storage_class + - all_storage_classes_128K + TransitionList: + type: array + items: + $ref: '#/components/schemas/Transition' + TransitionStorageClass: + type: string + enum: + - GLACIER + - STANDARD_IA + - ONEZONE_IA + - INTELLIGENT_TIERING + - DEEP_ARCHIVE + - GLACIER_IR + Type: + type: string + enum: + - CanonicalUser + - AmazonCustomerByEmail + - Group + URI: + type: string + UpdateBucketMetadataInventoryTableConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that corresponds to the metadata + configuration that you want to enable or disable an inventory table for. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: The `Content-MD5` header for the inventory table configuration. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The checksum algorithm to use with your inventory table configuration. + InventoryTableConfiguration: + $ref: '#/components/schemas/InventoryTableConfigurationUpdates' + description: The contents of your inventory table configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected owner of the general purpose bucket that corresponds + to the metadata table configuration that you want to enable or disable + an inventory table for. + required: + - Bucket + - InventoryTableConfiguration + UpdateBucketMetadataJournalTableConfigurationRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: The general purpose bucket that corresponds to the metadata + configuration that you want to enable or disable journal table record + expiration for. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: The `Content-MD5` header for the journal table configuration. + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: The checksum algorithm to use with your journal table configuration. + JournalTableConfiguration: + $ref: '#/components/schemas/JournalTableConfigurationUpdates' + description: The contents of your journal table configuration. + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: The expected owner of the general purpose bucket that corresponds + to the metadata table configuration that you want to enable or disable + journal table record expiration for. + required: + - Bucket + - JournalTableConfiguration + UploadIdMarker: + type: string + UploadPartCopyOutput: + type: object + properties: + CopySourceVersionId: + $ref: '#/components/schemas/CopySourceVersionId' + description: '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.' + CopyPartResult: + $ref: '#/components/schemas/CopyPartResult' + description: Container for all response elements. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the multipart upload uses an S3 Bucket Key + for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + UploadPartCopyRequest: + type: object + properties: + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + Copying objects across different Amazon Web Services Regions isn''t supported + when the source or destination bucket is in Amazon Web Services Local + Zones. The source and destination buckets must have the same parent Amazon + Web Services Region. Otherwise, you get an HTTP `400 Bad Request` error + with the error code `InvalidRequest`. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + CopySource: + $ref: '#/components/schemas/CopySource' + description: "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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):\n\ + \n * 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.\n\n * 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:::accesspoint//object/`.\ + \ 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.\n\n * Amazon S3 supports copy operations\ + \ using Access points only when the source and destination buckets are\ + \ in the same Amazon Web Services Region.\n\n * Access points are not\ + \ supported by directory buckets.\n\nAlternatively, for objects accessed\ + \ through Amazon S3 on Outposts, specify the ARN of the object as accessed\ + \ in the format `arn:aws:s3-outposts:::outpost//object/`. 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.\n\nIf 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=`\ + \ to the `x-amz-copy-source` request header (for example, `x-amz-copy-source:\ + \ /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`).\n\ + \nIf 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`.\n\ + \n**Directory buckets** \\- S3 Versioning isn't enabled and supported\ + \ for directory buckets." + CopySourceIfMatch: + $ref: '#/components/schemas/CopySourceIfMatch' + description: '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.' + CopySourceIfModifiedSince: + $ref: '#/components/schemas/CopySourceIfModifiedSince' + description: '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.' + CopySourceIfNoneMatch: + $ref: '#/components/schemas/CopySourceIfNoneMatch' + description: '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.' + CopySourceIfUnmodifiedSince: + $ref: '#/components/schemas/CopySourceIfUnmodifiedSince' + description: '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.' + CopySourceRange: + $ref: '#/components/schemas/CopySourceRange' + description: The range of bytes to copy from the source object. The range + value must use the form bytes=first-last, where the first and last are + the zero-based byte offsets to copy. For example, bytes=0-9 indicates + that you want to copy the first 10 bytes of the source. You can copy a + range only if the source object is greater than 5 MB. + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload was initiated. + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: Part number of part being copied. This is a positive integer + between 1 and 10,000. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: Upload ID identifying the multipart upload whose part is being + copied. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + CopySourceSSECustomerAlgorithm: + $ref: '#/components/schemas/CopySourceSSECustomerAlgorithm' + description: '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.' + CopySourceSSECustomerKey: + $ref: '#/components/schemas/CopySourceSSECustomerKey' + description: '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.' + CopySourceSSECustomerKeyMD5: + $ref: '#/components/schemas/CopySourceSSECustomerKeyMD5' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + ExpectedSourceBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - CopySource + - Key + - PartNumber + - UploadId + UploadPartOutput: + type: object + properties: + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when you store this + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + ETag: + $ref: '#/components/schemas/ETag' + description: Entity tag for the uploaded object. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: The Base64 encoded, 32-bit `CRC32 checksum` of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: The Base64 encoded, 32-bit `CRC32C` checksum of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the + part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: The Base64 encoded, 160-bit `SHA1` digest of the object. This + checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: The Base64 encoded, 256-bit `SHA256` digest of the object. + This checksum is only present if the checksum 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + in the _Amazon S3 User Guide_. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, indicates the ID of the KMS key that was used for + object encryption. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the multipart upload uses an S3 Bucket Key + for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + UploadPartRequest: + type: object + properties: + Body: + $ref: '#/components/schemas/StreamingBlob' + description: Object data. + Bucket: + $ref: '#/components/schemas/BucketName' + description: '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-_zone-id_._region-code_.amazonaws.com`. + Path-style requests are not supported. Directory bucket names must be + unique in the chosen Zone (Availability Zone or Local Zone). Bucket names + must follow the format ` _bucket-base-name_ --_zone-id_ --x-s3` (for example, + ` _amzn-s3-demo-bucket_ --_usw2-az1_ --x-s3`). For information about bucket + naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) + in the _Amazon S3 User Guide_. + + + **Access points** \- When you use this action with an access point for + general purpose buckets, you must provide the alias of the access point + in place of the bucket name or specify the access point ARN. When you + use this action with an access point for directory buckets, you must provide + the access point name in place of the bucket name. 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + in the _Amazon S3 User Guide_. + + + Object Lambda access points are not supported by directory buckets. + + + **S3 on Outposts** \- When you use this action with 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, the destination bucket must + be the Outposts access point ARN or the access point alias. For more information + about S3 on Outposts, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + in the _Amazon S3 User Guide_.' + ContentLength: + $ref: '#/components/schemas/ContentLength' + description: Size of the body in bytes. This parameter is useful when the + size of the body cannot be determined automatically. + ContentMD5: + $ref: '#/components/schemas/ContentMD5' + description: '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.' + ChecksumAlgorithm: + $ref: '#/components/schemas/ChecksumAlgorithm' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + 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.' + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32` checksum of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the + part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 160-bit `SHA1` digest of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 256-bit `SHA256` digest of the object. + For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + Key: + $ref: '#/components/schemas/ObjectKey' + description: Object key for which the multipart upload was initiated. + PartNumber: + $ref: '#/components/schemas/PartNumber' + description: Part number of part being uploaded. This is a positive integer + between 1 and 10,000. + UploadId: + $ref: '#/components/schemas/MultipartUploadId' + description: Upload ID identifying the multipart upload whose part is being + uploaded. + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: 'Specifies the algorithm to use when encrypting the object + (for example, AES256). + + + This functionality is not supported for directory buckets.' + SSECustomerKey: + $ref: '#/components/schemas/SSECustomerKey' + description: '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.' + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: '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.' + RequestPayer: + $ref: '#/components/schemas/RequestPayer' + ExpectedBucketOwner: + $ref: '#/components/schemas/AccountId' + description: 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). + required: + - Bucket + - Key + - PartNumber + - UploadId + UserMetadata: + type: array + items: + $ref: '#/components/schemas/MetadataEntry' + Value: + type: string + VersionCount: + type: integer + VersionIdMarker: + type: string + VersioningConfiguration: + type: object + properties: + MFADelete: + $ref: '#/components/schemas/MFADelete' + description: Specifies whether MFA delete is enabled in the bucket versioning + configuration. This element is only returned if the bucket has been configured + with MFA delete. If the bucket has never been so configured, this element + is not returned. + Status: + $ref: '#/components/schemas/BucketVersioningStatus' + description: The versioning state of the bucket. + description: Describes the versioning state of an Amazon S3 bucket. For more + information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) + in the _Amazon S3 API Reference_. + WebsiteConfiguration: + type: object + properties: + ErrorDocument: + $ref: '#/components/schemas/ErrorDocument' + description: The name of the error document for the website. + IndexDocument: + $ref: '#/components/schemas/IndexDocument' + description: The name of the index document for the website. + RedirectAllRequestsTo: + $ref: '#/components/schemas/RedirectAllRequestsTo' + description: 'The redirect behavior for every request to this bucket''s + website endpoint. + + + If you specify this property, you can''t specify any other property.' + RoutingRules: + $ref: '#/components/schemas/RoutingRules' + description: Rules that define when a redirect is applied and the redirect + behavior. + description: Specifies website configuration parameters for an Amazon S3 bucket. + WebsiteRedirectLocation: + type: string + WriteGetObjectResponseRequest: + type: object + properties: + RequestRoute: + $ref: '#/components/schemas/RequestRoute' + description: Route prefix to the HTTP URL generated. + RequestToken: + $ref: '#/components/schemas/RequestToken' + description: A single use encrypted token that maps `WriteGetObjectResponse` + to the end user `GetObject` request. + Body: + $ref: '#/components/schemas/StreamingBlob' + description: The object data. + StatusCode: + $ref: '#/components/schemas/GetObjectResponseStatusCode' + description: "The integer status code for an HTTP response of a corresponding\ + \ `GetObject` request. The following is a list of status codes.\n\n *\ + \ `200 - OK`\n\n * `206 - Partial Content`\n\n * `304 - Not Modified`\n\ + \n * `400 - Bad Request`\n\n * `401 - Unauthorized`\n\n * `403 - Forbidden`\n\ + \n * `404 - Not Found`\n\n * `405 - Method Not Allowed`\n\n * `409\ + \ - Conflict`\n\n * `411 - Length Required`\n\n * `412 - Precondition\ + \ Failed`\n\n * `416 - Range Not Satisfiable`\n\n * `500 - Internal\ + \ Server Error`\n\n * `503 - Service Unavailable`" + ErrorCode: + $ref: '#/components/schemas/ErrorCode' + description: A string that uniquely identifies an error condition. Returned + in the ` tag of the error XML response for a corresponding `GetObject` + call. Cannot be used with a successful `StatusCode` header or when the + transformed object is provided in the body. All error codes from S3 are + sentence-cased. The regular expression (regex) value is `"^[A-Z][a-zA-Z]+$"`. + ErrorMessage: + $ref: '#/components/schemas/ErrorMessage' + description: Contains a generic description of the error condition. Returned + in the tag of the error XML response for a corresponding `GetObject` + call. Cannot be used with a successful `StatusCode` header or when the + transformed object is provided in body. + AcceptRanges: + $ref: '#/components/schemas/AcceptRanges' + description: Indicates that a range of bytes was specified. + CacheControl: + $ref: '#/components/schemas/CacheControl' + description: Specifies caching behavior along the request/reply chain. + ContentDisposition: + $ref: '#/components/schemas/ContentDisposition' + description: Specifies presentational information for the object. + ContentEncoding: + $ref: '#/components/schemas/ContentEncoding' + description: 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. + ContentLanguage: + $ref: '#/components/schemas/ContentLanguage' + description: The language the content is in. + ContentLength: + $ref: '#/components/schemas/ContentLength' + description: The size of the content body in bytes. + ContentRange: + $ref: '#/components/schemas/ContentRange' + description: The portion of the object returned in the response. + ContentType: + $ref: '#/components/schemas/ContentType' + description: A standard MIME type describing the format of the object data. + ChecksumCRC32: + $ref: '#/components/schemas/ChecksumCRC32' + description: 'This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + specifies the Base64 encoded, 32-bit `CRC32` checksum of the object returned + by the Object Lambda function. This may not match the checksum for the + object stored in Amazon S3. Amazon S3 will perform validation of the checksum + values only when the original `GetObject` request required checksum validation. + For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + Only one checksum header can be specified at a time. If you supply multiple + checksum headers, this request will fail.' + ChecksumCRC32C: + $ref: '#/components/schemas/ChecksumCRC32C' + description: 'This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object returned + by the Object Lambda function. This may not match the checksum for the + object stored in Amazon S3. Amazon S3 will perform validation of the checksum + values only when the original `GetObject` request required checksum validation. + For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + Only one checksum header can be specified at a time. If you supply multiple + checksum headers, this request will fail.' + ChecksumCRC64NVME: + $ref: '#/components/schemas/ChecksumCRC64NVME' + description: This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + header specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the + part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + ChecksumSHA1: + $ref: '#/components/schemas/ChecksumSHA1' + description: 'This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + specifies the Base64 encoded, 160-bit `SHA1` digest of the object returned + by the Object Lambda function. This may not match the checksum for the + object stored in Amazon S3. Amazon S3 will perform validation of the checksum + values only when the original `GetObject` request required checksum validation. + For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + Only one checksum header can be specified at a time. If you supply multiple + checksum headers, this request will fail.' + ChecksumSHA256: + $ref: '#/components/schemas/ChecksumSHA256' + description: 'This header can be used as a data integrity check to verify + that the data received is the same data that was originally sent. This + specifies the Base64 encoded, 256-bit `SHA256` digest of the object returned + by the Object Lambda function. This may not match the checksum for the + object stored in Amazon S3. Amazon S3 will perform validation of the checksum + values only when the original `GetObject` request required checksum validation. + For more information about checksums, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + in the _Amazon S3 User Guide_. + + + Only one checksum header can be specified at a time. If you supply multiple + checksum headers, this request will fail.' + DeleteMarker: + $ref: '#/components/schemas/DeleteMarker' + description: Specifies whether an object stored in Amazon S3 is (`true`) + or is not (`false`) a delete marker. To learn more about delete markers, + see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html). + ETag: + $ref: '#/components/schemas/ETag' + description: An opaque identifier assigned by a web server to a specific + version of a resource found at a URL. + Expires: + $ref: '#/components/schemas/Expires' + description: The date and time at which the object is no longer cacheable. + Expiration: + $ref: '#/components/schemas/Expiration' + description: 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 that provide the object expiration information. The value + of the `rule-id` is URL-encoded. + LastModified: + $ref: '#/components/schemas/LastModified' + description: The date and time that the object was last modified. + MissingMeta: + $ref: '#/components/schemas/MissingMeta' + description: 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. + Metadata: + $ref: '#/components/schemas/Metadata' + description: A map of metadata to store with the object in S3. + ObjectLockMode: + $ref: '#/components/schemas/ObjectLockMode' + description: Indicates whether an object stored in Amazon S3 has Object + Lock enabled. For more information about S3 Object Lock, see [Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html). + ObjectLockLegalHoldStatus: + $ref: '#/components/schemas/ObjectLockLegalHoldStatus' + description: Indicates whether an object stored in Amazon S3 has an active + legal hold. + ObjectLockRetainUntilDate: + $ref: '#/components/schemas/ObjectLockRetainUntilDate' + description: The date and time when Object Lock is configured to expire. + PartsCount: + $ref: '#/components/schemas/PartsCount' + description: The count of parts this object has. + ReplicationStatus: + $ref: '#/components/schemas/ReplicationStatus' + description: Indicates if request involves bucket that is either a source + or destination in a Replication rule. For more information about S3 Replication, + see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html). + RequestCharged: + $ref: '#/components/schemas/RequestCharged' + Restore: + $ref: '#/components/schemas/Restore' + description: Provides information about object restoration operation and + expiration time of the restored object copy. + ServerSideEncryption: + $ref: '#/components/schemas/ServerSideEncryption' + description: 'The server-side encryption algorithm used when storing requested + object in Amazon S3 or Amazon FSx. + + + When accessing data stored in Amazon FSx file systems using S3 access + points, the only valid server side encryption option is `aws:fsx`.' + SSECustomerAlgorithm: + $ref: '#/components/schemas/SSECustomerAlgorithm' + description: Encryption algorithm used if server-side encryption with a + customer-provided encryption key was specified for object stored in Amazon + S3. + SSEKMSKeyId: + $ref: '#/components/schemas/SSEKMSKeyId' + description: If present, specifies the ID (Key ID, Key ARN, or Key Alias) + of the Amazon Web Services Key Management Service (Amazon Web Services + KMS) symmetric encryption customer managed key that was used for stored + in Amazon S3 object. + SSECustomerKeyMD5: + $ref: '#/components/schemas/SSECustomerKeyMD5' + description: 128-bit MD5 digest of customer-provided encryption key used + in Amazon S3 to encrypt data stored in S3. For more information, see [Protecting + data using server-side encryption with customer-provided encryption keys + (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html). + StorageClass: + $ref: '#/components/schemas/StorageClass' + description: '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](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).' + TagCount: + $ref: '#/components/schemas/TagCount' + description: The number of tags, if any, on the object. + VersionId: + $ref: '#/components/schemas/ObjectVersionId' + description: An ID used to reference a specific version of the object. + BucketKeyEnabled: + $ref: '#/components/schemas/BucketKeyEnabled' + description: Indicates whether the object stored in Amazon S3 uses an S3 + bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS). + required: + - RequestRoute + - RequestToken + WriteOffsetBytes: + type: integer + format: int64 + Years: + type: integer + metadatavalue: + type: object + description: Schema definition for metadatavalue (auto-generated placeholder) + x-orphaned: true + x-stackQL-resources: + bucket_abac: + id: aws.s3.bucket_abac + name: bucket_abac + title: Bucket Abac methods: - get_object_attributes: + get_bucket_abac: operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?attributes/get' + $ref: '#/paths/~1?abac/get' response: mediaType: text/xml openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_attributes/methods/get_object_attributes' - insert: [] - update: [] - delete: [] - object_lambda_responses: - id: aws.s3.object_lambda_responses - name: object_lambda_responses - title: Object Lambda Responses - methods: - write_get_object_response: + put_bucket_abac: operation: - $ref: '#/paths/~1WriteGetObjectResponse/post' + $ref: '#/paths/~1?abac/put' response: mediaType: application/json openAPIDocKey: '200' request: mediaType: application/xml - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - object_legal_holds: - id: aws.s3.object_legal_holds - name: object_legal_holds - title: Object Legal Holds - methods: - get_object_legal_hold: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?legal-hold/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_object_legal_hold: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?legal-hold/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_legal_holds/methods/get_object_legal_hold' - insert: [] - update: [] - delete: [] - object_lock_configurations: - id: aws.s3.object_lock_configurations - name: object_lock_configurations - title: Object Lock Configurations - methods: - get_object_lock_configuration: - operation: - $ref: '#/paths/~1{Bucket}?object-lock/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_object_lock_configuration: - operation: - $ref: '#/paths/~1{Bucket}?object-lock/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_lock_configurations/methods/get_object_lock_configuration' - insert: [] - update: [] - delete: [] - object_retention: - id: aws.s3.object_retention - name: object_retention - title: Object Retention - methods: - get_object_retention: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?retention/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_object_retention: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?retention/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_retention/methods/get_object_retention' - insert: [] - update: [] - delete: [] - object_tagging: - id: aws.s3.object_tagging - name: object_tagging - title: Object Tagging - methods: - delete_object_tagging: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?tagging/delete' - response: - mediaType: text/xml - openAPIDocKey: '204' - get_object_tagging: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?tagging/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - put_object_tagging: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?tagging/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_tagging/methods/get_object_tagging' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/object_tagging/methods/delete_object_tagging' - object_torrents: - id: aws.s3.object_torrents - name: object_torrents - title: Object Torrents - methods: - get_object_torrent: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?torrent/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_torrents/methods/get_object_torrent' - insert: [] - update: [] - delete: [] - object_versions: - id: aws.s3.object_versions - name: object_versions - title: Object Versions - methods: - list_object_versions: - operation: - $ref: '#/paths/~1{Bucket}?versions/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/object_versions/methods/list_object_versions' - insert: [] - update: [] - delete: [] - objects: - id: aws.s3.objects - name: objects - title: Objects - methods: - copy_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=CopyObject/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - delete_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=DeleteObject/delete' - response: - mediaType: text/xml - openAPIDocKey: '204' - delete_objects: - operation: - $ref: '#/paths/~1{Bucket}?delete/post' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - get_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=GetObject/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - head_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}/head' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_objects: - operation: - $ref: '#/paths/~1?max-keys=1000/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - objectKey: /*/Contents - put_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?x-id=PutObject/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - rename_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?renameObject/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - restore_object: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?restore/post' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - select_object_content: - operation: - $ref: '#/paths/~1{Bucket}~1{Key+}?select&select-type=2/post' - response: - mediaType: text/xml - openAPIDocKey: '200' - request: - mediaType: application/xml - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/objects/methods/get_object' - - $ref: '#/components/x-stackQL-resources/objects/methods/list_objects' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/objects/methods/delete_object' - - $ref: '#/components/x-stackQL-resources/objects/methods/delete_objects' - objects_v2: - id: aws.s3.objects_v2 - name: objects_v2 - title: Objects V2 - methods: - list_objects_v2: - operation: - $ref: '#/paths/~1{Bucket}?list-type=2/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - pagination: - requestToken: - key: ContinuationToken - location: query - responseToken: - key: NextContinuationToken - location: body + schema_override: + $ref: '#/components/schemas/AbacInputOverride' + transform: + type: golang_template_text_v0.1.0 + body: | + placeholder nothing to see here sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/objects_v2/methods/list_objects_v2' + - $ref: '#/components/x-stackQL-resources/bucket_abac/methods/get_bucket_abac' insert: [] update: [] delete: [] - public_access_blocks: - id: aws.s3.public_access_blocks - name: public_access_blocks - title: Public Access Blocks + bucket_acls: + id: aws.s3.bucket_acls + name: bucket_acls + title: Bucket Acls methods: - delete_public_access_block: - operation: - $ref: '#/paths/~1{Bucket}?publicAccessBlock/delete' - response: - mediaType: application/json - openAPIDocKey: '204' - get_public_access_block: + get_bucket_acl: operation: - $ref: '#/paths/~1{Bucket}?publicAccessBlock/get' + $ref: '#/paths/~1?acl/get' response: mediaType: text/xml openAPIDocKey: '200' - put_public_access_block: + put_bucket_acl: operation: - $ref: '#/paths/~1{Bucket}?publicAccessBlock/put' + $ref: '#/paths/~1?acl/put' response: mediaType: application/json openAPIDocKey: '200' @@ -23333,27 +13870,9 @@ components: mediaType: application/xml sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/public_access_blocks/methods/get_public_access_block' + - $ref: '#/components/x-stackQL-resources/bucket_acls/methods/get_bucket_acl' insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/public_access_blocks/methods/delete_public_access_block' - sessions: - id: aws.s3.sessions - name: sessions - title: Sessions - methods: - create_session: - operation: - $ref: '#/paths/~1{Bucket}?session/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/sessions/methods/create_session' - update: [] delete: [] x-stackQL-config: auth: diff --git a/cicd/tools/api/exported_funcs.txt b/cicd/tools/api/exported_funcs.txt index 5e64e6f..5e3e490 100644 --- a/cicd/tools/api/exported_funcs.txt +++ b/cicd/tools/api/exported_funcs.txt @@ -1,12 +1,14 @@ func CallFromSignature func CartesianProduct func ClientProtocolTypeFromString +func DecideAddressing func DecompressToPath func DefaultLinkHeaderTransformer func Execute func ExtractHTTPElement func ExtractParameterisedURL func ExtractProviderDesignation +func ExtractStackqlRequestContextValue func FilePathJoin func FindLatest func FindLatestStable @@ -109,6 +111,7 @@ func NewMarshalledBody func NewMethodAnalysisInput func NewMethodAnalyzer func NewNaiveBodyTranslator +func NewNaiveLateTranslator func NewNilTranslator func NewNopMapStream func NewOperationSelector diff --git a/cicd/tools/api/exported_interfaces.txt b/cicd/tools/api/exported_interfaces.txt index 1a18d04..e9fc1ff 100644 --- a/cicd/tools/api/exported_interfaces.txt +++ b/cicd/tools/api/exported_interfaces.txt @@ -53,6 +53,7 @@ type IDiscoveryAdapter interface type IDiscoveryStore interface type ITable interface type Interrogator interface +type LateTranslator interface type Manager interface type MapReader interface type MapStream interface diff --git a/cmd/argparse/query.go b/cmd/argparse/query.go index 90b0da2..d9f804e 100644 --- a/cmd/argparse/query.go +++ b/cmd/argparse/query.go @@ -4,6 +4,7 @@ import ( "encoding/json" "fmt" "io" + "net/http" "os" "runtime/pprof" @@ -54,15 +55,16 @@ func parseExecPayload( } type queryCmdPayload struct { - rtCtx dto.RuntimeCtx - provFilePath string - svcFilePath string - resourceStr string - methodName string - payload string - payloadType string - parameters map[string]interface{} - auth map[string]*dto.AuthCtx + rtCtx dto.RuntimeCtx + provFilePath string + svcFilePath string + resourceStr string + methodName string + payload string + payloadType string + parameters map[string]interface{} + auth map[string]*dto.AuthCtx + defaultHttpClient *http.Client // for testing purposes } func (qcp *queryCmdPayload) getService() (anysdk.Service, error) { @@ -217,6 +219,7 @@ func runQueryCommand(authCtx *dto.AuthCtx, payload *queryCmdPayload) error { cc := anysdk.NewAnySdkClientConfigurator( payload.rtCtx, prov.GetName(), + payload.defaultHttpClient, ) response, apiErr := anysdk.CallFromSignature( cc, payload.rtCtx, authCtx, authCtx.Type, false, os.Stderr, prov, anysdk.NewAnySdkOpStoreDesignation(opStore), argList) diff --git a/pkg/auth_util/auth_util.go b/pkg/auth_util/auth_util.go index 940477c..3ed83d6 100644 --- a/pkg/auth_util/auth_util.go +++ b/pkg/auth_util/auth_util.go @@ -99,11 +99,16 @@ type AuthUtility interface { } type authUtil struct { - // Placeholder for future implementation + defaultClient *http.Client } -func NewAuthUtility() AuthUtility { - return &authUtil{} +func NewAuthUtility(defaultClient *http.Client) AuthUtility { + if defaultClient == nil { + defaultClient = http.DefaultClient + } + return &authUtil{ + defaultClient: defaultClient, + } } type transport struct { @@ -341,7 +346,7 @@ func (au *authUtil) GoogleOauthServiceAccount( return nil, errToken } au.ActivateAuth(authCtx, "", dto.AuthServiceAccountStr) - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) return config.Client(context.WithValue(context.Background(), oauth2.HTTPClient, httpClient)), nil } @@ -355,7 +360,7 @@ func (au *authUtil) GenericOauthClientCredentials( return nil, errToken } au.ActivateAuth(authCtx, "", dto.ClientCredentialsStr) - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) return config.Client(context.WithValue(context.Background(), oauth2.HTTPClient, httpClient)), nil } @@ -365,7 +370,7 @@ func (au *authUtil) ApiTokenAuth(authCtx *dto.AuthCtx, httpContext netutils.HTTP return nil, fmt.Errorf("credentials error: %w", err) } au.ActivateAuth(authCtx, "", "api_key") - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) valPrefix := authCtx.ValuePrefix if enforceBearer { valPrefix = "Bearer " @@ -404,7 +409,7 @@ func (au *authUtil) AwsSigningAuth(authCtx *dto.AuthCtx, httpContext netutils.HT au.ActivateAuth(authCtx, "", dto.AuthAWSSigningv4Str) // Get the HTTP client from the runtime context. - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) // Initialize the AWS signing transport with credentials and optional session token. tr, err := awssign.NewAwsSignTransport(httpClient.Transport, keyID, keyStr, sessionToken) @@ -424,7 +429,7 @@ func (au *authUtil) BasicAuth(authCtx *dto.AuthCtx, httpContext netutils.HTTPCon return nil, fmt.Errorf("credentials error: %w", err) } au.ActivateAuth(authCtx, "", "basic") - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) tr, err := newTransport(b, AuthTypeBasic, authCtx.ValuePrefix, LocationHeader, "", httpClient.Transport) if err != nil { return nil, err @@ -439,7 +444,7 @@ func (au *authUtil) CustomAuth(authCtx *dto.AuthCtx, httpContext netutils.HTTPCo return nil, fmt.Errorf("credentials error: %w", err) } au.ActivateAuth(authCtx, "", "custom") - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) tr, err := newTransport(b, AuthTypeCustom, authCtx.ValuePrefix, authCtx.Location, authCtx.Name, httpClient.Transport) if err != nil { return nil, err @@ -482,7 +487,7 @@ func (au *authUtil) AzureDefaultAuth(authCtx *dto.AuthCtx, httpContext netutils. } tokenString := token.Token au.ActivateAuth(authCtx, "", "azure_default") - httpClient := netutils.GetHTTPClient(httpContext, http.DefaultClient) + httpClient := netutils.GetHTTPClient(httpContext, au.defaultClient) tr, err := newTransport([]byte(tokenString), AuthTypeBearer, "Bearer ", LocationHeader, "", httpClient.Transport) if err != nil { return nil, err diff --git a/pkg/dto/context_keys.go b/pkg/dto/context_keys.go new file mode 100644 index 0000000..32fc4a9 --- /dev/null +++ b/pkg/dto/context_keys.go @@ -0,0 +1,23 @@ +package dto + +import "context" + +type ContextKey string + +const ( + ContextPrefixStackqlRequest string = "stackql/request/" +) + +var ( + ContextKeyCreationDate = ContextKey("stackql/request/created_date") +) + +func ExtractStackqlRequestContextValue[T any](ctx context.Context, key ContextKey) (T, bool) { + val := ctx.Value(key) + if val == nil { + var zero T + return zero, false + } + typedVal, ok := val.(T) + return typedVal, ok +} diff --git a/pkg/latetranslator/late_translator.go b/pkg/latetranslator/late_translator.go new file mode 100644 index 0000000..e6890b0 --- /dev/null +++ b/pkg/latetranslator/late_translator.go @@ -0,0 +1,88 @@ +package latetranslator + +import ( + "net/http" + "regexp" + "time" + + "github.com/stackql/any-sdk/pkg/dto" + "github.com/stackql/any-sdk/pkg/s3balancer" +) + +var ( + s3VHostPattern string = `^(.+)\.s3[.-]((?:dualstack\.)?(?:fips-)?(?:[a-z0-9-]+))\.amazonaws\.com$` + s3VHostRegexp *regexp.Regexp = regexp.MustCompile(s3VHostPattern) +) + +type LateTranslator interface { + Translate(req *http.Request) (*http.Request, error) +} + +type naiveLateTranslator struct{} + +func NewNaiveLateTranslator() LateTranslator { + return &naiveLateTranslator{} +} + +func (nlt *naiveLateTranslator) requestDate(req *http.Request) time.Time { + if req == nil { + return time.Now() + } + ctx := req.Context() + if ctx == nil { + return time.Now() + } + raw := ctx.Value(dto.ContextKeyCreationDate) + dateStr, ok := raw.(string) + if !ok || dateStr == "" { + return time.Now() + } + if parsed, err := time.Parse(time.RFC3339, dateStr); err == nil { + return parsed + } + return time.Now() +} + +func (nlt *naiveLateTranslator) isS3BucketRequest(req *http.Request) bool { + hostname := req.URL.Hostname() + return s3VHostRegexp.MatchString(hostname) +} + +func (nlt *naiveLateTranslator) mutateS3BucketRequest(req *http.Request) (*http.Request, error) { + hostname := req.Host // Use req.Host for client-side reliability + matches := s3VHostRegexp.FindStringSubmatch(hostname) + + if len(matches) > 2 { + bucket := matches[1] + s3Segment := matches[2] // e.g., "s3.us-west-2" or "s3-fips.us-east-1" + + routeStyle := s3balancer.DecideAddressing( + bucket, + nlt.requestDate(req), + false, + ) + + if routeStyle == s3balancer.PathStyle { + // 1. Change Host to regional base (e.g., s3.us-west-2.amazonaws.com) + req.URL.Host = "s3." + s3Segment + ".amazonaws.com" + req.Host = req.URL.Host + + // 2. Prepend bucket to path + // Ensure we don't double-slash if Path is already "/" + if req.URL.Path == "" || req.URL.Path == "/" { + req.URL.Path = "/" + bucket + } else { + req.URL.Path = "/" + bucket + req.URL.Path + } + } + } + return req, nil +} + +func (nlt *naiveLateTranslator) Translate(req *http.Request) (*http.Request, error) { + isS3BucketRequest := nlt.isS3BucketRequest(req) + if isS3BucketRequest { + return nlt.mutateS3BucketRequest(req) + } + return req, nil +} diff --git a/pkg/latetranslator/late_translator_test.go b/pkg/latetranslator/late_translator_test.go new file mode 100644 index 0000000..d77593c --- /dev/null +++ b/pkg/latetranslator/late_translator_test.go @@ -0,0 +1,105 @@ +package latetranslator_test + +import ( + "context" + "net/http" + "net/url" + "testing" + "time" + + "github.com/stackql/any-sdk/pkg/dto" + "github.com/stackql/any-sdk/pkg/latetranslator" +) + +func TestTranslate(t *testing.T) { + translator := latetranslator.NewNaiveLateTranslator() + legacyDate := time.Date(2019, 1, 1, 0, 0, 0, 0, time.UTC).Format(time.RFC3339) + modernDate := time.Date(2025, 12, 31, 0, 0, 0, 0, time.UTC).Format(time.RFC3339) + + tests := []struct { + name string + incomingHost string + incomingPath string + wantHost string + wantPath string + date string + }{ + { + name: "Canonical Region Dash", + incomingHost: "my-bucket.s3-us-west-2.amazonaws.com", + incomingPath: "/photo.jpg", + wantHost: "my-bucket.s3-us-west-2.amazonaws.com", + wantPath: "/photo.jpg", + date: legacyDate, + }, + { + name: "Canonical Region Dot", + incomingHost: "logs.s3.eu-central-1.amazonaws.com", + incomingPath: "/", + wantHost: "logs.s3.eu-central-1.amazonaws.com", + wantPath: "/", + date: legacyDate, + }, + { + name: "Dualstack and FIPS", + incomingHost: "secure-data.s3-dualstack.fips-us-east-1.amazonaws.com", + incomingPath: "/secret.pdf", + wantHost: "secure-data.s3-dualstack.fips-us-east-1.amazonaws.com", + wantPath: "/secret.pdf", + date: legacyDate, + }, + { + name: "Bucket with Dots (S3 Specific)", + incomingHost: "my.sub.bucket.s3.us-east-1.amazonaws.com", + incomingPath: "/index.html", + wantHost: "s3.us-east-1.amazonaws.com", + wantPath: "/my.sub.bucket/index.html", + date: legacyDate, + }, + { + name: "Non-S3 Host (No Mutation)", + incomingHost: "example.com", + incomingPath: "/health", + wantHost: "example.com", + wantPath: "/health", + date: modernDate, + }, + { + name: "Already Path Style (No Mutation)", + incomingHost: "s3.us-west-2.amazonaws.com", + incomingPath: "/bucket/file", + wantHost: "s3.us-west-2.amazonaws.com", + wantPath: "/bucket/file", + date: modernDate, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + req := &http.Request{ + Host: tt.incomingHost, + URL: &url.URL{ + Host: tt.incomingHost, + Path: tt.incomingPath, + }, + } + if tt.date != "" { + ctx := req.Context() + ctx = context.WithValue(ctx, dto.ContextKeyCreationDate, tt.date) + req = req.WithContext(ctx) + } + + translated, err := translator.Translate(req) + if err != nil { + t.Fatalf("Translate failed: %v", err) + } + + if translated.Host != tt.wantHost { + t.Errorf("Host: got %q, want %q", translated.Host, tt.wantHost) + } + if translated.URL.Path != tt.wantPath { + t.Errorf("Path: got %q, want %q", translated.URL.Path, tt.wantPath) + } + }) + } +} diff --git a/pkg/s3balancer/s3_balancer.go b/pkg/s3balancer/s3_balancer.go new file mode 100644 index 0000000..bc0e72d --- /dev/null +++ b/pkg/s3balancer/s3_balancer.go @@ -0,0 +1,46 @@ +package s3balancer + +import ( + "strings" + "time" +) + +// S3Addressing represents the forced invariant for the request URL structure. +type S3Addressing int + +const ( + VirtualHost S3Addressing = iota + PathStyle +) + +var ( + // Invariant: Buckets created after this date PHYSICALLY CANNOT use PathStyle. + // S3 returns 403 Forbidden for path-style requests on these buckets. + PathStyleCutoff = time.Date(2020, time.September, 30, 0, 0, 0, 0, time.UTC) +) + +// DecideAddressing strictly determines the required S3 addressing style. +// entropy is zero; logic is dictated by AWS infrastructure invariants. +func DecideAddressing(bucketName string, created time.Time, forcePathStyle bool) S3Addressing { + // Invariant 1: ForcePathStyle is a user-level override. + // Logic check: Only allowed if bucket was created BEFORE the cutoff. + if forcePathStyle && created.Before(PathStyleCutoff) { + return PathStyle + } + + // Invariant 2: Modern Buckets (Post-2020) + // AWS mandates VirtualHost. There is no fallback. + if created.After(PathStyleCutoff) || created.Equal(PathStyleCutoff) { + return VirtualHost + } + + // Invariant 3: DNS Compatibility + // If a name contains dots, standard SDKs prefer PathStyle for TLS safety + // on legacy buckets. Since we are here, we know the bucket is Legacy (<2020). + if strings.Contains(bucketName, ".") { + return PathStyle + } + + // Default for legacy DNS-compliant buckets is VirtualHost. + return VirtualHost +} diff --git a/pkg/s3balancer/s3_balancer_test.go b/pkg/s3balancer/s3_balancer_test.go new file mode 100644 index 0000000..8ac4e19 --- /dev/null +++ b/pkg/s3balancer/s3_balancer_test.go @@ -0,0 +1,61 @@ +package s3balancer_test + +import ( + "testing" + "time" + + // Import the package under test + "github.com/stackql/any-sdk/pkg/s3balancer" +) + +func TestDecideAddressing_Invariants(t *testing.T) { + // 2026 Contextual Dates + legacyDate := time.Date(2019, 1, 1, 0, 0, 0, 0, time.UTC) + modernDate := time.Date(2025, 12, 31, 0, 0, 0, 0, time.UTC) + + tests := []struct { + name string + bucket string + created time.Time + forcePath bool + want s3balancer.S3Addressing + }{ + { + name: "Modern buckets are strictly VirtualHost (Post-2020 Invariant)", + bucket: "new-bucket.2026", + created: modernDate, + forcePath: false, + want: s3balancer.VirtualHost, + }, + { + name: "Modern buckets ignore forcePathStyle (Infrastructure Restriction)", + bucket: "modern-bucket", + created: modernDate, + forcePath: true, // This is a 'rubbish' configuration for modern S3 + want: s3balancer.VirtualHost, + }, + { + name: "Legacy dotted buckets default to PathStyle (SSL Safety)", + bucket: "old.dotted.bucket", + created: legacyDate, + forcePath: false, + want: s3balancer.PathStyle, + }, + { + name: "Legacy clean buckets default to VirtualHost", + bucket: "old-clean-bucket", + created: legacyDate, + forcePath: false, + want: s3balancer.VirtualHost, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := s3balancer.DecideAddressing(tt.bucket, tt.created, tt.forcePath) + if got != tt.want { + t.Errorf("FAIL [%s]: got %v, want %v", tt.name, got, tt.want) + } + }) + } +} diff --git a/pkg/urltranslate/urltranslate.go b/pkg/urltranslate/urltranslate.go index 127f1bd..d2c1236 100644 --- a/pkg/urltranslate/urltranslate.go +++ b/pkg/urltranslate/urltranslate.go @@ -33,6 +33,11 @@ func newStringFragment(s string) QueryElement { } } +type compositeFragment struct { + _ struct{} + raw string +} + func (sf *stringFragment) isQueryElement() {} func (sf *stringFragment) String() string { @@ -57,6 +62,22 @@ func (vwr *varWithRegexp) FullString() string { return fmt.Sprintf("{%s}", vwr.raw) } +func newCompositeFragment(s string) QueryElement { + return &compositeFragment{ + raw: s, + } +} + +func (sf *compositeFragment) isQueryElement() {} + +func (sf *compositeFragment) String() string { + return sf.raw +} + +func (sf *compositeFragment) FullString() string { + return sf.raw +} + type ParameterisedURL interface { Raw() string String() string @@ -93,6 +114,20 @@ func (uwp *urlWithParams) GetVarByName(name string) (QueryVar, bool) { return nil, false } +func extractTemplatedHost(raw string) string { + // 1. Remove the scheme (everything before and including "//") + _, hostAndPath, found := strings.Cut(raw, "//") + if !found { + // If no scheme is present, assume the string starts with the host + hostAndPath = raw + } + + // 2. Remove the path (everything starting from the first "/") + host, _, _ := strings.Cut(hostAndPath, "/") + + return host +} + func (uwp *urlWithParams) GetElementByString(s string) (QueryElement, bool) { isVar := strings.HasPrefix(s, "{") && strings.HasSuffix(s, "}") if isVar { @@ -100,7 +135,17 @@ func (uwp *urlWithParams) GetElementByString(s string) (QueryElement, bool) { varVal, ok := uwp.GetVarByName(varName) return varVal, ok } - return newStringFragment(s), strings.Contains(uwp.raw, s) + isContained := strings.Contains(uwp.String(), s) + isComposite := false + hostPart := extractTemplatedHost(uwp.raw) + if strings.Contains(hostPart, "{") { + isContained = true + isComposite = true + } + if isComposite { + return newCompositeFragment(hostPart), isContained + } + return newStringFragment(s), isContained } func extractRegexpVariable(v string) (QueryVar, error) { diff --git a/public/radix_tree_address_space/address_space.go b/public/radix_tree_address_space/address_space.go index 2eb66f1..b7e4917 100644 --- a/public/radix_tree_address_space/address_space.go +++ b/public/radix_tree_address_space/address_space.go @@ -11,6 +11,7 @@ import ( "github.com/getkin/kin-openapi/openapi3" "github.com/stackql/any-sdk/anysdk" "github.com/stackql/any-sdk/pkg/client" + "github.com/stackql/any-sdk/pkg/latetranslator" "github.com/stackql/any-sdk/pkg/media" "github.com/stackql/any-sdk/pkg/urltranslate" ) @@ -219,6 +220,7 @@ type standardNamespace struct { explicitAliasMap AliasMap globalAliasMap AliasMap shadowQuery RadixTree + lateTranslator latetranslator.LateTranslator } func selectServer(servers openapi3.Servers, inputParams map[string]interface{}) (string, error) { @@ -367,8 +369,11 @@ func (ns *standardNamespace) Invoke(argList ...any) error { httpReq.Body = io.NopCloser(bytes.NewBuffer(bodyBytes)) } ns.request = copiedRequest - - resp, respErr := v.Do(httpReq) + translatedReq, translateErr := ns.lateTranslator.Translate(copiedRequest) + if translateErr != nil { + return translateErr + } + resp, respErr := v.Do(translatedReq) if respErr != nil { return respErr } @@ -766,6 +771,7 @@ func (asa *standardAddressSpaceFormulator) Formulate() error { svc: asa.service, method: asa.method, shadowQuery: NewRadixTree(), + lateTranslator: latetranslator.NewNaiveLateTranslator(), } if addressSpace == nil { return fmt.Errorf("failed to create address space for operation %s", asa.method.GetName()) diff --git a/test/registry-simple/src/aws/v0.1.0/services/s3.yaml b/test/registry-simple/src/aws/v0.1.0/services/s3.yaml index ed2aa2d..e8b03ab 100644 --- a/test/registry-simple/src/aws/v0.1.0/services/s3.yaml +++ b/test/registry-simple/src/aws/v0.1.0/services/s3.yaml @@ -4425,7 +4425,7 @@ paths: description: Success /?abac: servers: - - url: 'https://{Bucket}.s3-{region}.amazonaws.com' + - url: 'https://{Bucket}.s3.{region}.amazonaws.com' variables: Bucket: default: stackql-trial-bucket-02