Class: AWS.S3Control

Inherits:
AWS.Service show all
Identifier:
s3control
API Version:
2018-08-20
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS S3 Control provides access to Amazon S3 control plane operations.

Sending a Request Using S3Control

var s3control = new AWS.S3Control();
s3control.createAccessPoint(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the S3Control object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var s3control = new AWS.S3Control({apiVersion: '2018-08-20'});

You can also set the API version globally in AWS.config.apiVersions using the s3control service identifier:

AWS.config.apiVersions = {
  s3control: '2018-08-20',
  // other service API versions
};

var s3control = new AWS.S3Control();

Version:

  • 2018-08-20

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, defineService

Constructor Details

new AWS.S3Control(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a S3Control object

var s3control = new AWS.S3Control({apiVersion: '2018-08-20'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • useDualstack (Boolean)

    Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. Note, however, that currently on Windows, the IPv4 address will be preferred.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.S3Control.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.S3Control.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.S3Control.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createAccessPoint(params = {}, callback) ⇒ AWS.Request

Creates an access point and associates it with the specified bucket.

Service Reference:

Examples:

Calling the createAccessPoint operation

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 AWS 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.

    • VpcConfiguration — (map)

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

      • VpcIdrequired — (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 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

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

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

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

      • 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 AWS services 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.

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.

createJob(params = {}, callback) ⇒ AWS.Request

You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the createJob operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Manifest: { /* required */
    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 */
      ]
    }
  },
  Operation: { /* required */
    LambdaInvoke: {
      FunctionArn: 'STRING_VALUE'
    },
    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 */
      ],
      CannedAccessControlList: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control,
      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,
      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 */
      ]
    }
  },
  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',
  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)

    • 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 operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide.

      • LambdaInvoke — (map)

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

        • FunctionArn — (String)

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

      • S3PutObjectCopy — (map)

        Directs the specified job to execute a PUT Copy object call on each object in the manifest.

        • TargetResource — (String)

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

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

          • Keyrequired — (String)

          • Valuerequired — (String)

        • RedirectLocation — (String)

        • RequesterPays — (Boolean)

        • StorageClass — (String)

          Possible values include:

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

        • SSEAwsKmsKeyId — (String)

        • TargetKeyPrefix — (String)

        • 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 will expire on all objects in the Batch Operations job.

      • S3PutObjectAcl — (map)

        Directs the specified job to execute a PUT Object acl call on each object in the manifest.

        • AccessControlPolicy — (map)

          • AccessControlList — (map)

            • Ownerrequired — (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 execute a PUT Object tagging call on each object in the manifest.

        • TagSet — (Array<map>)

          • Keyrequired — (String)

          • Valuerequired — (String)

      • S3InitiateRestoreObject — (map)

        Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.

        • ExpirationInDays — (Integer)

        • GlacierJobTier — (String)

          Possible values include:

          • "BULK"
          • "STANDARD"
      • S3PutObjectLegalHold — (map)

        Contains the configuration parameters for a Set Object Legal Hold operation. Amazon S3 Batch Operations passes each value through to the underlying PUT Object Legal Hold API. For more information about the parameters for this operation, see PUT Object Legal Hold.

        • LegalHoldrequired — (map)

          The Legal Hold contains the status to be applied to all objects in the Batch Operations job.

          • Statusrequired — (String)

            The 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 a Set Object Retention operation. Amazon S3 Batch Operations passes each value through to the underlying PUT Object Retention API. For more information about the parameters for this operation, see PUT Object Retention.

        • BypassGovernanceRetention — (Boolean)

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

        • Retentionrequired — (map)

          Amazon S3 object lock Retention contains the retention mode to be applied to all objects in the Batch Operations job.

          • RetainUntilDate — (Date)

            The date when the applied Object Retention will expire on all objects in the Batch Operations job.

          • Mode — (String)

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

            Possible values include:
            • "COMPLIANCE"
            • "GOVERNANCE"
    • 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"
      • Enabledrequired — (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 will store 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.

      • Specrequired — (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.

        • Formatrequired — (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.

      • Locationrequired — (map)

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

        • ObjectArnrequired — (String)

          The Amazon Resource Name (ARN) for a manifest object.

        • ObjectVersionId — (String)

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

        • ETagrequired — (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 AWS Identity and Access Management (IAM) role that Batch Operations will use to execute this job's operation on each object in the manifest.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

      • Valuerequired — (String)

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.

deleteAccessPoint(params = {}, callback) ⇒ AWS.Request

Deletes the specified access point.

Service Reference:

Examples:

Calling the deleteAccessPoint operation

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.

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.

deleteAccessPointPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the access point policy for the specified access point.

Service Reference:

Examples:

Calling the deleteAccessPointPolicy operation

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.

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.

deleteJobTagging(params = {}, callback) ⇒ AWS.Request

Removes the entire tag set from the specified Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the deleteJobTagging operation

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 AWS account ID associated with the Amazon S3 Batch Operations job.

    • JobId — (String)

      The ID for the Amazon 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.

deletePublicAccessBlock(params = {}, callback) ⇒ AWS.Request

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

Service Reference:

Examples:

Calling the deletePublicAccessBlock operation

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.

describeJob(params = {}, callback) ⇒ AWS.Request

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the describeJob operation

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)

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

          • Specrequired — (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.

            • Formatrequired — (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.

          • Locationrequired — (map)

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

            • ObjectArnrequired — (String)

              The Amazon Resource Name (ARN) for a manifest object.

            • ObjectVersionId — (String)

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

            • ETagrequired — (String)

              The ETag for the specified manifest object.

        • Operation — (map)

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

          • LambdaInvoke — (map)

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

            • FunctionArn — (String)

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

          • S3PutObjectCopy — (map)

            Directs the specified job to execute a PUT Copy object call on each object in the manifest.

            • TargetResource — (String)

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

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

              • Keyrequired — (String)

              • Valuerequired — (String)

            • RedirectLocation — (String)

            • RequesterPays — (Boolean)

            • StorageClass — (String)

              Possible values include:

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

            • SSEAwsKmsKeyId — (String)

            • TargetKeyPrefix — (String)

            • 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 will expire on all objects in the Batch Operations job.

          • S3PutObjectAcl — (map)

            Directs the specified job to execute a PUT Object acl call on each object in the manifest.

            • AccessControlPolicy — (map)

              • AccessControlList — (map)

                • Ownerrequired — (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 execute a PUT Object tagging call on each object in the manifest.

            • TagSet — (Array<map>)

              • Keyrequired — (String)

              • Valuerequired — (String)

          • S3InitiateRestoreObject — (map)

            Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.

            • ExpirationInDays — (Integer)

            • GlacierJobTier — (String)

              Possible values include:

              • "BULK"
              • "STANDARD"
          • S3PutObjectLegalHold — (map)

            Contains the configuration parameters for a Set Object Legal Hold operation. Amazon S3 Batch Operations passes each value through to the underlying PUT Object Legal Hold API. For more information about the parameters for this operation, see PUT Object Legal Hold.

            • LegalHoldrequired — (map)

              The Legal Hold contains the status to be applied to all objects in the Batch Operations job.

              • Statusrequired — (String)

                The 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 a Set Object Retention operation. Amazon S3 Batch Operations passes each value through to the underlying PUT Object Retention API. For more information about the parameters for this operation, see PUT Object Retention.

            • BypassGovernanceRetention — (Boolean)

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

            • Retentionrequired — (map)

              Amazon S3 object lock Retention contains the retention mode to be applied to all objects in the Batch Operations job.

              • RetainUntilDate — (Date)

                The date when the applied Object Retention will expire on all objects in the Batch Operations job.

              • Mode — (String)

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

                Possible values include:
                • "COMPLIANCE"
                • "GOVERNANCE"
        • Priority — (Integer)

          The priority of the specified job.

        • ProgressSummary — (map)

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

          • TotalNumberOfTasks — (Integer)

          • NumberOfTasksSucceeded — (Integer)

          • NumberOfTasksFailed — (Integer)

        • StatusUpdateReason — (String)

        • 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"
          • Enabledrequired — (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 will store 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 AWS Identity and Access Management (IAM) role assigned to execute 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.

Returns:

  • (AWS.Request)

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

getAccessPoint(params = {}, callback) ⇒ AWS.Request

Returns configuration information about the specified access point.

Service Reference:

Examples:

Calling the getAccessPoint operation

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.

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.

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

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

        • VpcIdrequired — (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 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

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

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

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

        • 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 AWS services 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.

      • CreationDate — (Date)

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

Returns:

  • (AWS.Request)

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

getAccessPointPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getAccessPointPolicy operation

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.

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.

getAccessPointPolicyStatus(params = {}, callback) ⇒ AWS.Request

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Service Reference:

Examples:

Calling the getAccessPointPolicyStatus operation

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.

getJobTagging(params = {}, callback) ⇒ AWS.Request

Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the getJobTagging operation

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 AWS account ID associated with the Amazon S3 Batch Operations job.

    • JobId — (String)

      The ID for the Amazon 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 Amazon S3 Batch Operations job.

        • Keyrequired — (String)

        • Valuerequired — (String)

Returns:

  • (AWS.Request)

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

getPublicAccessBlock(params = {}, callback) ⇒ AWS.Request

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

Service Reference:

Examples:

Calling the getPublicAccessBlock operation

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.

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

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

        • 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 AWS services 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.

Returns:

  • (AWS.Request)

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

listAccessPoints(params = {}, callback) ⇒ AWS.Request

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

Service Reference:

Examples:

Calling the listAccessPoints operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3control.listAccessPoints(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 AWS account ID for owner of the bucket whose access points you want to list.

    • Bucket — (String)

      The name of the bucket whose associated access points you want to list.

    • NextToken — (String)

      A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

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:

      • AccessPointList — (Array<map>)

        Contains identification and configuration information for one or more access points associated with the specified bucket.

        • Namerequired — (String)

          The name of this access point.

        • NetworkOriginrequired — (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.

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

          The virtual private cloud (VPC) configuration for this access point, if one exists.

          • VpcIdrequired — (String)

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

        • Bucketrequired — (String)

          The name of the bucket associated with this access point.

      • NextToken — (String)

        If the specified bucket has more access points than can be returned in one call to this API, then this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

Returns:

  • (AWS.Request)

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

listJobs(params = {}, callback) ⇒ AWS.Request

Lists current Amazon S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the listJobs operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobStatuses: [
    Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready | Suspended,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3control.listJobs(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)

    • JobStatuses — (Array<String>)

      The List Jobs request returns jobs that match the statuses listed in this element.

    • NextToken — (String)

      A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

    • MaxResults — (Integer)

      The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

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:

      • NextToken — (String)

        If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

      • Jobs — (Array<map>)

        The list of current jobs and jobs that have ended within the last 30 days.

        • JobId — (String)

          The ID for the specified job.

        • Description — (String)

          The user-specified description that was included in the specified job's Create Job request.

        • Operation — (String)

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

          Possible values include:
          • "LambdaInvoke"
          • "S3PutObjectCopy"
          • "S3PutObjectAcl"
          • "S3PutObjectTagging"
          • "S3InitiateRestoreObject"
          • "S3PutObjectLegalHold"
          • "S3PutObjectRetention"
        • Priority — (Integer)

          The current priority for the specified job.

        • Status — (String)

          The specified job's current status.

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

          A timestamp indicating when the specified job was created.

        • TerminationDate — (Date)

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

        • ProgressSummary — (map)

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

          • TotalNumberOfTasks — (Integer)

          • NumberOfTasksSucceeded — (Integer)

          • NumberOfTasksFailed — (Integer)

Returns:

  • (AWS.Request)

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

putAccessPointPolicy(params = {}, callback) ⇒ AWS.Request

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

Service Reference:

Examples:

Calling the putAccessPointPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE' /* required */
};
s3control.putAccessPointPolicy(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 AWS account ID for owner of the bucket associated with the specified access point.

    • Name — (String)

      The name of the access point that you want to associate with the specified policy.

    • Policy — (String)

      The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer 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.

Returns:

  • (AWS.Request)

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

putJobTagging(params = {}, callback) ⇒ AWS.Request

Set the supplied tag-set on an Amazon S3 Batch Operations job.

A tag is a key-value pair. You can associate Amazon S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the tag set with the one you have modified.. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide.

Note:
  • If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you will be charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
  • For deleting existing tags for your batch operations job, DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
  • A few things to consider about using tags:
    • Amazon S3 limits the maximum number of tags to 50 tags per job.
    • You can associate up to 50 tags with a job as long as they have unique tag keys.
    • A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
    • The key and values are case sensitive.
    • For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions.

To use this operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

Service Reference:

Examples:

Calling the putJobTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
s3control.putJobTagging(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 AWS account ID associated with the Amazon S3 Batch Operations job.

    • JobId — (String)

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

    • Tags — (Array<map>)

      The set of tags to associate with the Amazon S3 Batch Operations job.

      • Keyrequired — (String)

      • Valuerequired — (String)

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.

putPublicAccessBlock(params = {}, callback) ⇒ AWS.Request

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.

Service Reference:

Examples:

Calling the putPublicAccessBlock operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  PublicAccessBlockConfiguration: { /* required */
    BlockPublicAcls: true || false,
    BlockPublicPolicy: true || false,
    IgnorePublicAcls: true || false,
    RestrictPublicBuckets: true || false
  }
};
s3control.putPublicAccessBlock(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: {})
    • PublicAccessBlockConfiguration — (map)

      The PublicAccessBlock configuration that you want to apply to the specified 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.

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

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

      • 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 AWS services 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.

    • AccountId — (String)

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

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.

updateJobPriority(params = {}, callback) ⇒ AWS.Request

Updates an existing Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the updateJobPriority operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  Priority: 'NUMBER_VALUE' /* required */
};
s3control.updateJobPriority(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)

    • JobId — (String)

      The ID for the job whose priority you want to update.

    • Priority — (Integer)

      The priority you want to assign to this job.

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 the job whose priority Amazon S3 updated.

      • Priority — (Integer)

        The new priority assigned to the specified job.

Returns:

  • (AWS.Request)

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

updateJobStatus(params = {}, callback) ⇒ AWS.Request

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Service Reference:

Examples:

Calling the updateJobStatus operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  RequestedJobStatus: Cancelled | Ready, /* required */
  StatusUpdateReason: 'STRING_VALUE'
};
s3control.updateJobStatus(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)

    • JobId — (String)

      The ID of the job whose status you want to update.

    • RequestedJobStatus — (String)

      The status that you want to move the specified job to.

      Possible values include:
      • "Cancelled"
      • "Ready"
    • StatusUpdateReason — (String)

      A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.

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 the job whose status was updated.

      • Status — (String)

        The current status for the specified job.

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

        The reason that the specified job's status was updated.

Returns:

  • (AWS.Request)

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