Class: AWS.S3Control

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  PublicAccessBlockConfiguration: {
    BlockPublicAcls: true || false,
    BlockPublicPolicy: true || false,
    IgnorePublicAcls: true || false,
    RestrictPublicBuckets: true || false
  },
  VpcConfiguration: {
    VpcId: 'STRING_VALUE' /* required */
  }
};
s3control.createAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account ID for the owner of the bucket for which you want to create an access point.

  • Name — (String)

    The name you want to assign to this access point.

  • Bucket — (String)

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

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

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

  • VpcConfiguration — (map)

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

    Note: This is required for creating an access point for Amazon S3 on Outposts buckets.
    • VpcId — required — (String)

      If this field is specified, this access point will only allow connections from the specified VPC ID.

  • PublicAccessBlockConfiguration — (map)

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

    • BlockPublicAcls — (Boolean)

      Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

      • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

      • PUT Object calls fail if the request includes a public ACL.

      • PUT Bucket calls fail if the request includes a public ACL.

      Enabling this setting doesn't affect existing policies or ACLs.

      This is not supported for Amazon S3 on Outposts.

    • IgnorePublicAcls — (Boolean)

      Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

      Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

      This is not supported for Amazon S3 on Outposts.

    • BlockPublicPolicy — (Boolean)

      Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

      This is not supported for Amazon S3 on Outposts.

    • RestrictPublicBuckets — (Boolean)

      Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

      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.

      This is not supported for Amazon S3 on Outposts.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccessPointArn — (String)

      The ARN of the access point.

      Note: This is only supported by Amazon S3 on Outposts.
    • Alias — (String)

      The name or alias of the access point.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Configuration: { /* required */
    SupportingAccessPoint: 'STRING_VALUE', /* required */
    TransformationConfigurations: [ /* required */
      {
        Actions: [ /* required */
          GetObject,
          /* more items */
        ],
        ContentTransformation: { /* required */
          AwsLambda: {
            FunctionArn: 'STRING_VALUE', /* required */
            FunctionPayload: 'STRING_VALUE'
          }
        }
      },
      /* more items */
    ],
    AllowedFeatures: [
      GetObject-Range | GetObject-PartNumber,
      /* more items */
    ],
    CloudWatchMetricsEnabled: true || false
  },
  Name: 'STRING_VALUE' /* required */
};
s3control.createAccessPointForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

  • Configuration — (map)

    Object Lambda Access Point configuration as a JSON document.

    • SupportingAccessPoint — required — (String)

      Standard access point associated with the Object Lambda Access Point.

    • CloudWatchMetricsEnabled — (Boolean)

      A container for whether the CloudWatch metrics configuration is enabled.

    • AllowedFeatures — (Array<String>)

      A container for allowed features. Valid inputs are GetObject-Range and GetObject-PartNumber.

    • TransformationConfigurations — required — (Array<map>)

      A container for transformation configurations for an Object Lambda Access Point.

      • Actions — required — (Array<String>)

        A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.

      • ContentTransformation — required — (map)

        A container for the content transformation of an Object Lambda Access Point configuration.

        • AwsLambda — (map)

          A container for an Lambda function.

          • FunctionArn — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function.

          • FunctionPayload — (String)

            Additional JSON that provides supplemental data to the Lambda function used to transform objects.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ObjectLambdaAccessPointArn — (String)

      Specifies the ARN for the Object Lambda Access Point.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read,
  CreateBucketConfiguration: {
    LocationConstraint: EU | eu-west-1 | us-west-1 | us-west-2 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1 | cn-north-1 | eu-central-1
  },
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWrite: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  ObjectLockEnabledForBucket: true || false,
  OutpostId: 'STRING_VALUE'
};
s3control.createBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ACL — (String)

    The canned ACL to apply to the bucket.

    Note: This is not supported by Amazon S3 on Outposts buckets.
    Possible values include:
    • "private"
    • "public-read"
    • "public-read-write"
    • "authenticated-read"
  • Bucket — (String)

    The name of the bucket.

  • CreateBucketConfiguration — (map)

    The configuration information for the bucket.

    Note: This is not supported by Amazon S3 on Outposts buckets.
    • LocationConstraint — (String)

      Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.

      Note: This is not supported by Amazon S3 on Outposts buckets.
      Possible values include:
      • "EU"
      • "eu-west-1"
      • "us-west-1"
      • "us-west-2"
      • "ap-south-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-northeast-1"
      • "sa-east-1"
      • "cn-north-1"
      • "eu-central-1"
  • GrantFullControl — (String)

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

    Note: This is not supported by Amazon S3 on Outposts buckets.
  • GrantRead — (String)

    Allows grantee to list the objects in the bucket.

    Note: This is not supported by Amazon S3 on Outposts buckets.
  • GrantReadACP — (String)

    Allows grantee to read the bucket ACL.

    Note: This is not supported by Amazon S3 on Outposts buckets.
  • GrantWrite — (String)

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

    Note: This is not supported by Amazon S3 on Outposts buckets.
  • GrantWriteACP — (String)

    Allows grantee to write the ACL for the applicable bucket.

    Note: This is not supported by Amazon S3 on Outposts buckets.
  • ObjectLockEnabledForBucket — (Boolean)

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

    Note: This is not supported by Amazon S3 on Outposts buckets.
  • OutpostId — (String)

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

    Note: This is required by Amazon S3 on Outposts buckets.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Location — (String)

      The location of the bucket.

    • BucketArn — (String)

      The Amazon Resource Name (ARN) of the bucket.

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

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Operation: { /* required */
    LambdaInvoke: {
      FunctionArn: 'STRING_VALUE'
    },
    S3DeleteObjectTagging: {
    },
    S3InitiateRestoreObject: {
      ExpirationInDays: 'NUMBER_VALUE',
      GlacierJobTier: BULK | STANDARD
    },
    S3PutObjectAcl: {
      AccessControlPolicy: {
        AccessControlList: {
          Owner: { /* required */
            DisplayName: 'STRING_VALUE',
            ID: 'STRING_VALUE'
          },
          Grants: [
            {
              Grantee: {
                DisplayName: 'STRING_VALUE',
                Identifier: 'STRING_VALUE',
                TypeIdentifier: id | emailAddress | uri
              },
              Permission: FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP
            },
            /* more items */
          ]
        },
        CannedAccessControlList: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control
      }
    },
    S3PutObjectCopy: {
      AccessControlGrants: [
        {
          Grantee: {
            DisplayName: 'STRING_VALUE',
            Identifier: 'STRING_VALUE',
            TypeIdentifier: id | emailAddress | uri
          },
          Permission: FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP
        },
        /* more items */
      ],
      BucketKeyEnabled: true || false,
      CannedAccessControlList: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control,
      ChecksumAlgorithm: CRC32 | CRC32C | SHA1 | SHA256,
      MetadataDirective: COPY | REPLACE,
      ModifiedSinceConstraint: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      NewObjectMetadata: {
        CacheControl: 'STRING_VALUE',
        ContentDisposition: 'STRING_VALUE',
        ContentEncoding: 'STRING_VALUE',
        ContentLanguage: 'STRING_VALUE',
        ContentLength: 'NUMBER_VALUE',
        ContentMD5: 'STRING_VALUE',
        ContentType: 'STRING_VALUE',
        HttpExpiresDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        RequesterCharged: true || false,
        SSEAlgorithm: AES256 | KMS,
        UserMetadata: {
          '<NonEmptyMaxLength1024String>': 'STRING_VALUE',
          /* '<NonEmptyMaxLength1024String>': ... */
        }
      },
      NewObjectTagging: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      ObjectLockLegalHoldStatus: OFF | ON,
      ObjectLockMode: COMPLIANCE | GOVERNANCE,
      ObjectLockRetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      RedirectLocation: 'STRING_VALUE',
      RequesterPays: true || false,
      SSEAwsKmsKeyId: 'STRING_VALUE',
      StorageClass: STANDARD | STANDARD_IA | ONEZONE_IA | GLACIER | INTELLIGENT_TIERING | DEEP_ARCHIVE | GLACIER_IR,
      TargetKeyPrefix: 'STRING_VALUE',
      TargetResource: 'STRING_VALUE',
      UnModifiedSinceConstraint: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    S3PutObjectLegalHold: {
      LegalHold: { /* required */
        Status: OFF | ON /* required */
      }
    },
    S3PutObjectRetention: {
      Retention: { /* required */
        Mode: COMPLIANCE | GOVERNANCE,
        RetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      BypassGovernanceRetention: true || false
    },
    S3PutObjectTagging: {
      TagSet: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    S3ReplicateObject: {
    }
  },
  Priority: 'NUMBER_VALUE', /* required */
  Report: { /* required */
    Enabled: true || false, /* required */
    Bucket: 'STRING_VALUE',
    Format: Report_CSV_20180820,
    Prefix: 'STRING_VALUE',
    ReportScope: AllTasks | FailedTasksOnly
  },
  RoleArn: 'STRING_VALUE', /* required */
  ConfirmationRequired: true || false,
  Description: 'STRING_VALUE',
  Manifest: {
    Location: { /* required */
      ETag: 'STRING_VALUE', /* required */
      ObjectArn: 'STRING_VALUE', /* required */
      ObjectVersionId: 'STRING_VALUE'
    },
    Spec: { /* required */
      Format: S3BatchOperations_CSV_20180820 | S3InventoryReport_CSV_20161130, /* required */
      Fields: [
        Ignore | Bucket | Key | VersionId,
        /* more items */
      ]
    }
  },
  ManifestGenerator: {
    S3JobManifestGenerator: {
      EnableManifestOutput: true || false, /* required */
      SourceBucket: 'STRING_VALUE', /* required */
      ExpectedBucketOwner: 'STRING_VALUE',
      Filter: {
        CreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        CreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        EligibleForReplication: true || false,
        ObjectReplicationStatuses: [
          COMPLETED | FAILED | REPLICA | NONE,
          /* more items */
        ]
      },
      ManifestOutputLocation: {
        Bucket: 'STRING_VALUE', /* required */
        ManifestFormat: S3InventoryReport_CSV_20211130, /* required */
        ExpectedManifestBucketOwner: 'STRING_VALUE',
        ManifestEncryption: {
          SSEKMS: {
            KeyId: 'STRING_VALUE' /* required */
          },
          SSES3: {
          }
        },
        ManifestPrefix: 'STRING_VALUE'
      }
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
s3control.createJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account ID that creates the job.

  • ConfirmationRequired — (Boolean)

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

  • Operation — (map)

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

    • LambdaInvoke — (map)

      Directs the specified job to invoke an Lambda function on every object in the manifest.

      • FunctionArn — (String)

        The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.

    • S3PutObjectCopy — (map)

      Directs the specified job to run a PUT Copy object call on every object in the manifest.

      • TargetResource — (String)

        Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".

      • CannedAccessControlList — (String)

        Possible values include:

        • "private"
        • "public-read"
        • "public-read-write"
        • "aws-exec-read"
        • "authenticated-read"
        • "bucket-owner-read"
        • "bucket-owner-full-control"
      • AccessControlGrants — (Array<map>)
        • Grantee — (map)
          • TypeIdentifier — (String)

            Possible values include:

            • "id"
            • "emailAddress"
            • "uri"
          • Identifier — (String)

          • DisplayName — (String)

        • Permission — (String)

          Possible values include:

          • "FULL_CONTROL"
          • "READ"
          • "WRITE"
          • "READ_ACP"
          • "WRITE_ACP"
      • MetadataDirective — (String)

        Possible values include:

        • "COPY"
        • "REPLACE"
      • ModifiedSinceConstraint — (Date)

      • NewObjectMetadata — (map)

        If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

        • CacheControl — (String)

        • ContentDisposition — (String)

        • ContentEncoding — (String)

        • ContentLanguage — (String)

        • UserMetadata — (map<String>)

        • ContentLength — (Integer)

        • ContentMD5 — (String)

        • ContentType — (String)

        • HttpExpiresDate — (Date)

        • RequesterCharged — (Boolean)

        • SSEAlgorithm — (String)

          Possible values include:

          • "AES256"
          • "KMS"
      • NewObjectTagging — (Array<map>)
        • Key — required — (String)

        • Value — required — (String)

      • RedirectLocation — (String)

        Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

      • RequesterPays — (Boolean)

      • StorageClass — (String)

        Possible values include:

        • "STANDARD"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "GLACIER"
        • "INTELLIGENT_TIERING"
        • "DEEP_ARCHIVE"
        • "GLACIER_IR"
      • UnModifiedSinceConstraint — (Date)

      • SSEAwsKmsKeyId — (String)

      • TargetKeyPrefix — (String)

        Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix to Folder1.

      • ObjectLockLegalHoldStatus — (String)

        The legal hold status to be applied to all objects in the Batch Operations job.

        Possible values include:
        • "OFF"
        • "ON"
      • ObjectLockMode — (String)

        The retention mode to be applied to all objects in the Batch Operations job.

        Possible values include:
        • "COMPLIANCE"
        • "GOVERNANCE"
      • ObjectLockRetainUntilDate — (Date)

        The date when the applied object retention configuration expires on all objects in the Batch Operations job.

      • BucketKeyEnabled — (Boolean)

        Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

        Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

      • ChecksumAlgorithm — (String)

        Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.

        Possible values include:
        • "CRC32"
        • "CRC32C"
        • "SHA1"
        • "SHA256"
    • S3PutObjectAcl — (map)

      Directs the specified job to run a PUT Object acl call on every object in the manifest.

      • AccessControlPolicy — (map)
        • AccessControlList — (map)
          • Owner — required — (map)
            • ID — (String)

            • DisplayName — (String)

          • Grants — (Array<map>)
            • Grantee — (map)
              • TypeIdentifier — (String)

                Possible values include:

                • "id"
                • "emailAddress"
                • "uri"
              • Identifier — (String)

              • DisplayName — (String)

            • Permission — (String)

              Possible values include:

              • "FULL_CONTROL"
              • "READ"
              • "WRITE"
              • "READ_ACP"
              • "WRITE_ACP"
        • CannedAccessControlList — (String)

          Possible values include:

          • "private"
          • "public-read"
          • "public-read-write"
          • "aws-exec-read"
          • "authenticated-read"
          • "bucket-owner-read"
          • "bucket-owner-full-control"
    • S3PutObjectTagging — (map)

      Directs the specified job to run a PUT Object tagging call on every object in the manifest.

      • TagSet — (Array<map>)
        • Key — required — (String)

        • Value — required — (String)

    • S3DeleteObjectTagging — (map)

      Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

    • S3InitiateRestoreObject — (map)

      Directs the specified job to initiate restore requests for every archived object in the manifest.

      • ExpirationInDays — (Integer)

        This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

        Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

        S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

      • GlacierJobTier — (String)

        S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

        Possible values include:
        • "BULK"
        • "STANDARD"
    • S3PutObjectLegalHold — (map)

      Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

      • LegalHold — required — (map)

        Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

        • Status — required — (String)

          The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

          Possible values include:
          • "OFF"
          • "ON"
    • S3PutObjectRetention — (map)

      Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

      • BypassGovernanceRetention — (Boolean)

        Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

      • Retention — required — (map)

        Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

        • RetainUntilDate — (Date)

          The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

        • Mode — (String)

          The Object Lock retention mode to be applied to all objects in the Batch Operations job.

          Possible values include:
          • "COMPLIANCE"
          • "GOVERNANCE"
    • S3ReplicateObject — (map)

      Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

  • Report — (map)

    Configuration parameters for the optional job-completion report.

    • Bucket — (String)

      The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

    • Format — (String)

      The format of the specified job-completion report.

      Possible values include:
      • "Report_CSV_20180820"
    • Enabled — required — (Boolean)

      Indicates whether the specified job will generate a job-completion report.

    • Prefix — (String)

      An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

    • ReportScope — (String)

      Indicates whether the job-completion report will include details of all tasks or only failed tasks.

      Possible values include:
      • "AllTasks"
      • "FailedTasksOnly"
  • ClientRequestToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • Manifest — (map)

    Configuration parameters for the manifest.

    • Spec — required — (map)

      Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

      • Format — required — (String)

        Indicates which of the available formats the specified manifest uses.

        Possible values include:
        • "S3BatchOperations_CSV_20180820"
        • "S3InventoryReport_CSV_20161130"
      • Fields — (Array<String>)

        If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

    • Location — required — (map)

      Contains the information required to locate the specified job's manifest.

      • ObjectArn — required — (String)

        The Amazon Resource Name (ARN) for a manifest 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.

      • ObjectVersionId — (String)

        The optional version ID to identify a specific version of the manifest object.

      • ETag — required — (String)

        The ETag for the specified manifest object.

  • Description — (String)

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

  • Priority — (Integer)

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

  • RoleArn — (String)

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

  • Tags — (Array<map>)

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

    • Key — required — (String)

    • Value — required — (String)

  • ManifestGenerator — (map)

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

    • S3JobManifestGenerator — (map)

      The S3 job ManifestGenerator's configuration details.

      • ExpectedBucketOwner — (String)

        The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

      • SourceBucket — required — (String)

        The source bucket used by the ManifestGenerator.

      • ManifestOutputLocation — (map)

        Specifies the location the generated manifest will be written to.

        • ExpectedManifestBucketOwner — (String)

          The Account ID that owns the bucket the generated manifest is written to.

        • Bucket — required — (String)

          The bucket ARN the generated manifest should be written to.

        • ManifestPrefix — (String)

          Prefix identifying one or more objects to which the manifest applies.

        • ManifestEncryption — (map)

          Specifies what encryption should be used when the generated manifest objects are written.

          • SSES3 — (map)

            Specifies the use of SSE-S3 to encrypt generated manifest objects.

          • SSEKMS — (map)

            Configuration details on how SSE-KMS is used to encrypt generated manifest objects.

            • KeyId — required — (String)

              Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting generated manifest objects.

        • ManifestFormat — required — (String)

          The format of the generated manifest.

          Possible values include:
          • "S3InventoryReport_CSV_20211130"
      • Filter — (map)

        Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

        • EligibleForReplication — (Boolean)

          Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.

        • CreatedAfter — (Date)

          If provided, the generated manifest should include only source bucket objects that were created after this time.

        • CreatedBefore — (Date)

          If provided, the generated manifest should include only source bucket objects that were created before this time.

        • ObjectReplicationStatuses — (Array<String>)

          If provided, the generated manifest should include only source bucket objects that have one of the specified Replication statuses.

      • EnableManifestOutput — required — (Boolean)

        Determines whether or not to write the job's generated manifest to a bucket.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

      The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE', /* required */
  Details: { /* required */
    Name: 'STRING_VALUE', /* required */
    Regions: [ /* required */
      {
        Bucket: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    PublicAccessBlock: {
      BlockPublicAcls: true || false,
      BlockPublicPolicy: true || false,
      IgnorePublicAcls: true || false,
      RestrictPublicBuckets: true || false
    }
  }
};
s3control.createMultiRegionAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • ClientToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • Details — (map)

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

    • Name — required — (String)

      The name of the Multi-Region Access Point associated with this request.

    • PublicAccessBlock — (map)

      The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. 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" in the Amazon S3 User Guide.

      This is not supported for Amazon S3 on Outposts.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

        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.

        This is not supported for Amazon S3 on Outposts.

    • Regions — required — (Array<map>)

      The buckets in different Regions that are associated with the Multi-Region Access Point.

      • Bucket — required — (String)

        The name of the associated bucket for the Region.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RequestTokenARN — (String)

      The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    The name of the access point you want to delete.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPointForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    The name of the access point you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPointPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPointPolicyForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID that owns the Outposts bucket.

  • Bucket — (String)

    Specifies the bucket being deleted.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucketLifecycleConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the lifecycle configuration to delete.

  • Bucket — (String)

    Specifies the bucket.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucketPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the Outposts bucket.

  • Bucket — (String)

    Specifies the bucket.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucketTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Bucket — (String)

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
s3control.deleteJobTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE', /* required */
  Details: { /* required */
    Name: 'STRING_VALUE' /* required */
  }
};
s3control.deleteMultiRegionAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • ClientToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • Details — (map)

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

    • Name — required — (String)

      The name of the Multi-Region Access Point associated with this request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RequestTokenARN — (String)

      The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
s3control.deletePublicAccessBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.deleteStorageLensConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConfigId — (String)

    The ID of the S3 Storage Lens configuration.

  • AccountId — (String)

    The account ID of the requester.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.deleteStorageLensConfigurationTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConfigId — (String)

    The ID of the S3 Storage Lens configuration.

  • AccountId — (String)

    The account ID of the requester.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
s3control.describeJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Job — (map)

      Contains the configuration parameters and status for the job specified in the Describe Job request.

      • JobId — (String)

        The ID for the specified job.

      • ConfirmationRequired — (Boolean)

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

      • Description — (String)

        The description for this job, if one was provided in this job's Create Job request.

      • JobArn — (String)

        The Amazon Resource Name (ARN) for this job.

      • Status — (String)

        The current status of the specified job.

        Possible values include:
        • "Active"
        • "Cancelled"
        • "Cancelling"
        • "Complete"
        • "Completing"
        • "Failed"
        • "Failing"
        • "New"
        • "Paused"
        • "Pausing"
        • "Preparing"
        • "Ready"
        • "Suspended"
      • Manifest — (map)

        The configuration information for the specified job's manifest object.

        • Spec — required — (map)

          Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

          • Format — required — (String)

            Indicates which of the available formats the specified manifest uses.

            Possible values include:
            • "S3BatchOperations_CSV_20180820"
            • "S3InventoryReport_CSV_20161130"
          • Fields — (Array<String>)

            If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

        • Location — required — (map)

          Contains the information required to locate the specified job's manifest.

          • ObjectArn — required — (String)

            The Amazon Resource Name (ARN) for a manifest 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.

          • ObjectVersionId — (String)

            The optional version ID to identify a specific version of the manifest object.

          • ETag — required — (String)

            The ETag for the specified manifest object.

      • Operation — (map)

        The operation that the specified job is configured to run on the objects listed in the manifest.

        • LambdaInvoke — (map)

          Directs the specified job to invoke an Lambda function on every object in the manifest.

          • FunctionArn — (String)

            The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.

        • S3PutObjectCopy — (map)

          Directs the specified job to run a PUT Copy object call on every object in the manifest.

          • TargetResource — (String)

            Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".

          • CannedAccessControlList — (String)

            Possible values include:

            • "private"
            • "public-read"
            • "public-read-write"
            • "aws-exec-read"
            • "authenticated-read"
            • "bucket-owner-read"
            • "bucket-owner-full-control"
          • AccessControlGrants — (Array<map>)
            • Grantee — (map)
              • TypeIdentifier — (String)

                Possible values include:

                • "id"
                • "emailAddress"
                • "uri"
              • Identifier — (String)

              • DisplayName — (String)

            • Permission — (String)

              Possible values include:

              • "FULL_CONTROL"
              • "READ"
              • "WRITE"
              • "READ_ACP"
              • "WRITE_ACP"
          • MetadataDirective — (String)

            Possible values include:

            • "COPY"
            • "REPLACE"
          • ModifiedSinceConstraint — (Date)

          • NewObjectMetadata — (map)

            If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

            • CacheControl — (String)

            • ContentDisposition — (String)

            • ContentEncoding — (String)

            • ContentLanguage — (String)

            • UserMetadata — (map<String>)

            • ContentLength — (Integer)

            • ContentMD5 — (String)

            • ContentType — (String)

            • HttpExpiresDate — (Date)

            • RequesterCharged — (Boolean)

            • SSEAlgorithm — (String)

              Possible values include:

              • "AES256"
              • "KMS"
          • NewObjectTagging — (Array<map>)
            • Key — required — (String)

            • Value — required — (String)

          • RedirectLocation — (String)

            Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

          • RequesterPays — (Boolean)

          • StorageClass — (String)

            Possible values include:

            • "STANDARD"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "GLACIER"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
            • "GLACIER_IR"
          • UnModifiedSinceConstraint — (Date)

          • SSEAwsKmsKeyId — (String)

          • TargetKeyPrefix — (String)

            Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix to Folder1.

          • ObjectLockLegalHoldStatus — (String)

            The legal hold status to be applied to all objects in the Batch Operations job.

            Possible values include:
            • "OFF"
            • "ON"
          • ObjectLockMode — (String)

            The retention mode to be applied to all objects in the Batch Operations job.

            Possible values include:
            • "COMPLIANCE"
            • "GOVERNANCE"
          • ObjectLockRetainUntilDate — (Date)

            The date when the applied object retention configuration expires on all objects in the Batch Operations job.

          • BucketKeyEnabled — (Boolean)

            Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

            Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

          • ChecksumAlgorithm — (String)

            Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.

            Possible values include:
            • "CRC32"
            • "CRC32C"
            • "SHA1"
            • "SHA256"
        • S3PutObjectAcl — (map)

          Directs the specified job to run a PUT Object acl call on every object in the manifest.

          • AccessControlPolicy — (map)
            • AccessControlList — (map)
              • Owner — required — (map)
                • ID — (String)

                • DisplayName — (String)

              • Grants — (Array<map>)
                • Grantee — (map)
                  • TypeIdentifier — (String)

                    Possible values include:

                    • "id"
                    • "emailAddress"
                    • "uri"
                  • Identifier — (String)

                  • DisplayName — (String)

                • Permission — (String)

                  Possible values include:

                  • "FULL_CONTROL"
                  • "READ"
                  • "WRITE"
                  • "READ_ACP"
                  • "WRITE_ACP"
            • CannedAccessControlList — (String)

              Possible values include:

              • "private"
              • "public-read"
              • "public-read-write"
              • "aws-exec-read"
              • "authenticated-read"
              • "bucket-owner-read"
              • "bucket-owner-full-control"
        • S3PutObjectTagging — (map)

          Directs the specified job to run a PUT Object tagging call on every object in the manifest.

          • TagSet — (Array<map>)
            • Key — required — (String)

            • Value — required — (String)

        • S3DeleteObjectTagging — (map)

          Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

        • S3InitiateRestoreObject — (map)

          Directs the specified job to initiate restore requests for every archived object in the manifest.

          • ExpirationInDays — (Integer)

            This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

            Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

            S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

          • GlacierJobTier — (String)

            S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

            Possible values include:
            • "BULK"
            • "STANDARD"
        • S3PutObjectLegalHold — (map)

          Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

          • LegalHold — required — (map)

            Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

            • Status — required — (String)

              The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

              Possible values include:
              • "OFF"
              • "ON"
        • S3PutObjectRetention — (map)

          Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

          • BypassGovernanceRetention — (Boolean)

            Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

          • Retention — required — (map)

            Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

            • RetainUntilDate — (Date)

              The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

            • Mode — (String)

              The Object Lock retention mode to be applied to all objects in the Batch Operations job.

              Possible values include:
              • "COMPLIANCE"
              • "GOVERNANCE"
        • S3ReplicateObject — (map)

          Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

      • Priority — (Integer)

        The priority of the specified job.

      • ProgressSummary — (map)

        Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

        • TotalNumberOfTasks — (Integer)

        • NumberOfTasksSucceeded — (Integer)

        • NumberOfTasksFailed — (Integer)

        • Timers — (map)

          The JobTimers attribute of a job's progress summary.

          • ElapsedTimeInActiveSeconds — (Integer)

            Indicates the elapsed time in seconds the job has been in the Active job state.

      • StatusUpdateReason — (String)

        The reason for updating the job.

      • FailureReasons — (Array<map>)

        If the specified job failed, this field contains information describing the failure.

        • FailureCode — (String)

          The failure code, if any, for the specified job.

        • FailureReason — (String)

          The failure reason, if any, for the specified job.

      • Report — (map)

        Contains the configuration information for the job-completion report if you requested one in the Create Job request.

        • Bucket — (String)

          The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

        • Format — (String)

          The format of the specified job-completion report.

          Possible values include:
          • "Report_CSV_20180820"
        • Enabled — required — (Boolean)

          Indicates whether the specified job will generate a job-completion report.

        • Prefix — (String)

          An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

        • ReportScope — (String)

          Indicates whether the job-completion report will include details of all tasks or only failed tasks.

          Possible values include:
          • "AllTasks"
          • "FailedTasksOnly"
      • CreationTime — (Date)

        A timestamp indicating when this job was created.

      • TerminationDate — (Date)

        A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.

      • SuspendedDate — (Date)

        The timestamp when this job was suspended, if it has been suspended.

      • SuspendedCause — (String)

        The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

      • ManifestGenerator — (map)

        The manifest generator that was used to generate a job manifest for this job.

        • S3JobManifestGenerator — (map)

          The S3 job ManifestGenerator's configuration details.

          • ExpectedBucketOwner — (String)

            The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

          • SourceBucket — required — (String)

            The source bucket used by the ManifestGenerator.

          • ManifestOutputLocation — (map)

            Specifies the location the generated manifest will be written to.

            • ExpectedManifestBucketOwner — (String)

              The Account ID that owns the bucket the generated manifest is written to.

            • Bucket — required — (String)

              The bucket ARN the generated manifest should be written to.

            • ManifestPrefix — (String)

              Prefix identifying one or more objects to which the manifest applies.

            • ManifestEncryption — (map)

              Specifies what encryption should be used when the generated manifest objects are written.

              • SSES3 — (map)

                Specifies the use of SSE-S3 to encrypt generated manifest objects.

              • SSEKMS — (map)

                Configuration details on how SSE-KMS is used to encrypt generated manifest objects.

                • KeyId — required — (String)

                  Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting generated manifest objects.

            • ManifestFormat — required — (String)

              The format of the generated manifest.

              Possible values include:
              • "S3InventoryReport_CSV_20211130"
          • Filter — (map)

            Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

            • EligibleForReplication — (Boolean)

              Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.

            • CreatedAfter — (Date)

              If provided, the generated manifest should include only source bucket objects that were created after this time.

            • CreatedBefore — (Date)

              If provided, the generated manifest should include only source bucket objects that were created before this time.

            • ObjectReplicationStatuses — (Array<String>)

              If provided, the generated manifest should include only source bucket objects that have one of the specified Replication statuses.

          • EnableManifestOutput — required — (Boolean)

            Determines whether or not to write the job's generated manifest to a bucket.

      • GeneratedManifestDescriptor — (map)

        The attribute of the JobDescriptor containing details about the job's generated manifest.

        • Format — (String)

          The format of the generated manifest.

          Possible values include:
          • "S3InventoryReport_CSV_20211130"
        • Location — (map)

          Contains the information required to locate a manifest object.

          • ObjectArn — required — (String)

            The Amazon Resource Name (ARN) for a manifest 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.

          • ObjectVersionId — (String)

            The optional version ID to identify a specific version of the manifest object.

          • ETag — required — (String)

            The ETag for the specified manifest object.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  RequestTokenARN: 'STRING_VALUE' /* required */
};
s3control.describeMultiRegionAccessPointOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • RequestTokenARN — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AsyncOperation — (map)

      A container element containing the details of the asynchronous operation.

      • CreationTime — (Date)

        The time that the request was sent to the service.

      • Operation — (String)

        The specific operation for the asynchronous request.

        Possible values include:
        • "CreateMultiRegionAccessPoint"
        • "DeleteMultiRegionAccessPoint"
        • "PutMultiRegionAccessPointPolicy"
      • RequestTokenARN — (String)

        The request token associated with the request.

      • RequestParameters — (map)

        The parameters associated with the request.

        • CreateMultiRegionAccessPointRequest — (map)

          A container of the parameters for a CreateMultiRegionAccessPoint request.

          • Name — required — (String)

            The name of the Multi-Region Access Point associated with this request.

          • PublicAccessBlock — (map)

            The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. 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" in the Amazon S3 User Guide.

            This is not supported for Amazon S3 on Outposts.

            • BlockPublicAcls — (Boolean)

              Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

              • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

              • PUT Object calls fail if the request includes a public ACL.

              • PUT Bucket calls fail if the request includes a public ACL.

              Enabling this setting doesn't affect existing policies or ACLs.

              This is not supported for Amazon S3 on Outposts.

            • IgnorePublicAcls — (Boolean)

              Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

              Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

              This is not supported for Amazon S3 on Outposts.

            • BlockPublicPolicy — (Boolean)

              Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

              This is not supported for Amazon S3 on Outposts.

            • RestrictPublicBuckets — (Boolean)

              Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

              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.

              This is not supported for Amazon S3 on Outposts.

          • Regions — required — (Array<map>)

            The buckets in different Regions that are associated with the Multi-Region Access Point.

            • Bucket — required — (String)

              The name of the associated bucket for the Region.

        • DeleteMultiRegionAccessPointRequest — (map)

          A container of the parameters for a DeleteMultiRegionAccessPoint request.

          • Name — required — (String)

            The name of the Multi-Region Access Point associated with this request.

        • PutMultiRegionAccessPointPolicyRequest — (map)

          A container of the parameters for a PutMultiRegionAccessPoint request.

          • Name — required — (String)

            The name of the Multi-Region Access Point associated with the request.

          • Policy — required — (String)

            The policy details for the PutMultiRegionAccessPoint request.

      • RequestStatus — (String)

        The current status of the request.

      • ResponseDetails — (map)

        The details of the response.

        • MultiRegionAccessPointDetails — (map)

          The details for the Multi-Region Access Point.

          • Regions — (Array<map>)

            A collection of status information for the different Regions that a Multi-Region Access Point supports.

            • Name — (String)

              The name of the Region in the Multi-Region Access Point.

            • RequestStatus — (String)

              The current status of the Multi-Region Access Point in this Region.

        • ErrorDetails — (map)

          Error details for an asynchronous request.

          • Code — (String)

            A string that uniquely identifies the error condition.

          • Message — (String)

            A generic descritpion of the error condition in English.

          • Resource — (String)

            The identifier of the resource associated with the error.

          • RequestId — (String)

            The ID of the request associated with the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the specified access point.

    • Bucket — (String)

      The name of the bucket associated with the specified access point.

    • NetworkOrigin — (String)

      Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

      This will always be true for an Amazon S3 on Outposts access point

      Possible values include:
      • "Internet"
      • "VPC"
    • VpcConfiguration — (map)

      Contains the virtual private cloud (VPC) configuration for the specified access point.

      Note: This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services.
      • VpcId — required — (String)

        If this field is specified, this access point will only allow connections from the specified VPC ID.

    • PublicAccessBlockConfiguration — (map)

      The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. 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" in the Amazon S3 User Guide.

      This is not supported for Amazon S3 on Outposts.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

        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.

        This is not supported for Amazon S3 on Outposts.

    • CreationDate — (Date)

      The date and time when the specified access point was created.

    • Alias — (String)

      The name or alias of the access point.

    • AccessPointArn — (String)

      The ARN of the access point.

    • Endpoints — (map<String>)

      The VPC endpoint for the access point.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointConfigurationForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Configuration — (map)

      Object Lambda Access Point configuration document.

      • SupportingAccessPoint — required — (String)

        Standard access point associated with the Object Lambda Access Point.

      • CloudWatchMetricsEnabled — (Boolean)

        A container for whether the CloudWatch metrics configuration is enabled.

      • AllowedFeatures — (Array<String>)

        A container for allowed features. Valid inputs are GetObject-Range and GetObject-PartNumber.

      • TransformationConfigurations — required — (Array<map>)

        A container for transformation configurations for an Object Lambda Access Point.

        • Actions — required — (Array<String>)

          A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.

        • ContentTransformation — required — (map)

          A container for the content transformation of an Object Lambda Access Point configuration.

          • AwsLambda — (map)

            A container for an Lambda function.

            • FunctionArn — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function.

            • FunctionPayload — (String)

              Additional JSON that provides supplemental data to the Lambda function used to transform objects.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    The name of the Object Lambda Access Point.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the Object Lambda Access Point.

    • PublicAccessBlockConfiguration — (map)

      Configuration to block all public access. This setting is turned on and can not be edited.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

        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.

        This is not supported for Amazon S3 on Outposts.

    • CreationDate — (Date)

      The date and time when the specified Object Lambda Access Point was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (String)

      The access point policy associated with the specified access point.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicyForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    The name of the Object Lambda Access Point.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (String)

      Object Lambda Access Point resource policy document.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicyStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PolicyStatus — (map)

      Indicates the current policy status of the specified access point.

      • IsPublic — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicyStatusForObjectLambda(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    The name of the Object Lambda Access Point.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PolicyStatus — (map)

      Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of "Public" in the Amazon S3 User Guide.

      • IsPublic — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account ID of the Outposts bucket.

  • Bucket — (String)

    Specifies the bucket.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Bucket — (String)

      The Outposts bucket requested.

    • PublicAccessBlockEnabled — (Boolean)

    • CreationDate — (Date)

      The creation date of the Outposts bucket.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucketLifecycleConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account ID of the Outposts bucket.

  • Bucket — (String)

    The Amazon Resource Name (ARN) of the bucket.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Rules — (Array<map>)

      Container for the lifecycle rule of the Outposts bucket.

      • Expiration — (map)

        Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

        • Date — (Date)

          Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.

        • Days — (Integer)

          Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

        • ExpiredObjectDeleteMarker — (Boolean)

          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.

      • ID — (String)

        Unique identifier for the rule. The value cannot be longer than 255 characters.

      • Filter — (map)

        The container for the filter of lifecycle rule.

        • Prefix — (String)

          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.

        • Tag — (map)
          • Key — required — (String)

          • Value — required — (String)

        • And — (map)

          The container for the AND condition for the lifecycle rule.

          • Prefix — (String)

            Prefix identifying one or more objects to which the rule applies.

          • Tags — (Array<map>)

            All of these tags must exist in the object's tag set in order for the rule to apply.

            • Key — required — (String)

            • Value — required — (String)

      • Status — required — (String)

        If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • Transitions — (Array<map>)

        Specifies when an Amazon S3 object transitions to a specified storage class.

        Note: This is not supported by Amazon S3 on Outposts buckets.
        • Date — (Date)

          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 — (Integer)

          Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

        • StorageClass — (String)

          The storage class to which you want the object to transition.

          Possible values include:
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
      • NoncurrentVersionTransitions — (Array<map>)

        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.

        Note: This is not supported by Amazon S3 on Outposts buckets.
        • NoncurrentDays — (Integer)

          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 in the Amazon S3 User Guide.

        • StorageClass — (String)

          The class of storage used to store the object.

          Possible values include:
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
      • NoncurrentVersionExpiration — (map)

        The noncurrent version expiration of the lifecycle rule.

        Note: This is not supported by Amazon S3 on Outposts buckets.
        • NoncurrentDays — (Integer)

          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 When an Object Became Noncurrent in the Amazon S3 User Guide.

      • AbortIncompleteMultipartUpload — (map)

        Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

        • DaysAfterInitiation — (Integer)

          Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucketPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account ID of the Outposts bucket.

  • Bucket — (String)

    Specifies the bucket.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (String)

      The policy of the Outposts bucket.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucketTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account ID of the Outposts bucket.

  • Bucket — (String)

    Specifies the bucket.

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TagSet — (Array<map>)

      The tags set of the Outposts bucket.

      • Key — required — (String)

      • Value — required — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
s3control.getJobTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      The set of tags associated with the S3 Batch Operations job.

      • Key — required — (String)

      • Value — required — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getMultiRegionAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccessPoint — (map)

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

      • Name — (String)

        The name of the Multi-Region Access Point.

      • Alias — (String)

        The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points.

      • CreatedAt — (Date)

        When the Multi-Region Access Point create request was received.

      • PublicAccessBlock — (map)

        The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. 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" in the Amazon S3 User Guide.

        This is not supported for Amazon S3 on Outposts.

        • BlockPublicAcls — (Boolean)

          Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

          • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

          • PUT Object calls fail if the request includes a public ACL.

          • PUT Bucket calls fail if the request includes a public ACL.

          Enabling this setting doesn't affect existing policies or ACLs.

          This is not supported for Amazon S3 on Outposts.

        • IgnorePublicAcls — (Boolean)

          Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

          Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

          This is not supported for Amazon S3 on Outposts.

        • BlockPublicPolicy — (Boolean)

          Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

          This is not supported for Amazon S3 on Outposts.

        • RestrictPublicBuckets — (Boolean)

          Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

          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.

          This is not supported for Amazon S3 on Outposts.

      • Status — (String)

        The current status of the Multi-Region Access Point.

        CREATING and DELETING are temporary states that exist while the request is propogating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.

        Possible values include:
        • "READY"
        • "INCONSISTENT_ACROSS_REGIONS"
        • "CREATING"
        • "PARTIALLY_CREATED"
        • "PARTIALLY_DELETED"
        • "DELETING"
      • Regions — (Array<map>)

        A collection of the Regions and buckets associated with the Multi-Region Access Point.

        • Bucket — (String)

          The name of the bucket.

        • Region — (String)

          The name of the Region.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getMultiRegionAccessPointPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (map)

      The policy associated with the specified Multi-Region Access Point.

      • Established — (map)

        The last established policy for the Multi-Region Access Point.

        • Policy — (String)

          The details of the last established policy.

      • Proposed — (map)

        The proposed policy for the Multi-Region Access Point.

        • Policy — (String)

          The details of the proposed policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getMultiRegionAccessPointPolicyStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

  • Name — (String)

    Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Established — (map)

      Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of "Public" in the Amazon S3 User Guide.

      • IsPublic — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
s3control.getPublicAccessBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PublicAccessBlockConfiguration — (map)

      The PublicAccessBlock configuration currently in effect for this Amazon Web Services account.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.

        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.

        This is not supported for Amazon S3 on Outposts.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.getStorageLensConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConfigId — (String)

    The ID of the Amazon S3 Storage Lens configuration.

  • AccountId — (String)

    The account ID of the requester.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StorageLensConfiguration — (map)

      The S3 Storage Lens configuration requested.

      • Id — required — (String)

        A container for the Amazon S3 Storage Lens configuration ID.

      • AccountLevel — required — (map)

        A container for all the account-level configurations of your S3 Storage Lens configuration.

        • ActivityMetrics — (map)

          A container for the S3 Storage Lens activity metrics.

          • IsEnabled — (Boolean)

            A container for whether the activity metrics are enabled.

        • BucketLevel — required — (map)

          A container for the S3 Storage Lens bucket-level configuration.

          • ActivityMetrics — (map)

            A container for the bucket-level activity metrics for Amazon S3 Storage Lens

            • IsEnabled — (Boolean)

              A container for whether the activity metrics are enabled.

          • PrefixLevel — (map)

            A container for the bucket-level prefix-level metrics for S3 Storage Lens

            • StorageMetrics — required — (map)

              A container for the prefix-level storage metrics for S3 Storage Lens.

              • IsEnabled — (Boolean)

                A container for whether prefix-level storage metrics are enabled.

              • SelectionCriteria — (map)
                • Delimiter — (String)

                  A container for the delimiter of the selection criteria being used.

                • MaxDepth — (Integer)

                  The max depth of the selection criteria

                • MinStorageBytesPercentage — (Float)

                  The minimum number of storage bytes percentage whose metrics will be selected.

                  Note: You must choose a value greater than or equal to 1.0.
      • Include — (map)

        A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

        • Buckets — (Array<String>)

          A container for the S3 Storage Lens bucket includes.

        • Regions — (Array<String>)

          A container for the S3 Storage Lens Region includes.

      • Exclude — (map)

        A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

        • Buckets — (Array<String>)

          A container for the S3 Storage Lens bucket excludes.

        • Regions — (Array<String>)

          A container for the S3 Storage Lens Region excludes.

      • DataExport — (map)

        A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

        • S3BucketDestination — (map)

          A container for the bucket where the S3 Storage Lens metrics export will be located.

          Note: This bucket must be located in the same Region as the storage lens configuration.
          • Format — required — (String)

            Possible values include:

            • "CSV"
            • "Parquet"
          • OutputSchemaVersion — required — (String)

            The schema version of the export file.

            Possible values include:
            • "V_1"
          • AccountId — required — (String)

            The account ID of the owner of the S3 Storage Lens metrics export bucket.

          • Arn — required — (String)

            The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name

          • Prefix — (String)

            The prefix of the destination bucket where the metrics export will be delivered.

          • Encryption — (map)

            The container for the type encryption of the metrics exports in this bucket.

            • SSES3 — (map)

            • SSEKMS — (map)
              • KeyId — required — (String)

                A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e

        • CloudWatchMetrics — (map)

          A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.

          • IsEnabled — required — (Boolean)

            A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.

      • IsEnabled — required — (Boolean)

        A container for whether the S3 Storage Lens configuration is enabled.

      • AwsOrg — (map)

        A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

        • Arn — required — (String)

          A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property is read-only and follows the following format: arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck

      • StorageLensArn — (String)

        The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name