Skeddly API
Search
K

AmazonCopyS3ObjectsParameters Object

Description

Parameters for the Amazon Copy S3 Objects action.

Properties

aclSettings

Indicates whether ACL (permission) settings should be copied from the source objects.
Type: string
Valid Values:
  • none
  • copy
Required: No
Default: none

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.
Type: Array of string
Required: Yes

isTest

Determines if "Test Mode" is enabled on the action. Objects will not be copied when "Test Mode" is enabled.
Type: boolean
Required: No
Default Value: false

overwriteRule

Specifies whether objects in the target folder can be overwritten.
Type: string
Valid Values:
  • never-overwrite
  • always-overwrite
  • overwrite-older-objects-only
Required: No
Default: always-overwrite

regionNames

Regions to use with the action. One and only one region must be specified.
Type: Array of string
Required: Yes

renameMethod

Indicates whether object names should be modified during the copy process.
Type: string
Valid Values:
  • none
  • change-prefix
Required: No
Default: none

sourceBucketName

Name of the S3 bucket containing the objects to copy.
Type: string
Required: Yes

sourcePrefix

Prefix to use in the source bucket to limit the objects being copied.
Type: string
Required: No

storageClass

Indicates the storage class to use for the copied objects.
Type: string
Valid Values:
  • copy-from-source
  • standard
  • reduced-redundancy
  • standard-infrequent-access
Required: No
Default: copy-from-source

targetBucketName

Name of the S3 bucket to which the objects will be copied.
Type: string
Required: Yes

targetPrefix

Prefix to use in the target bucket for the copied objects. Replaces sourcePrefixfor each object name. Only used when renameMethod is change-prefix.
Type: string
Required: No

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"regionNames": [
"us-east-1"
],
"sourceBucketName": "bucket1",
"sourcePrefix": "MyDocuments/",
"targetBucketName": "bucket2",
"renameMethod": "change-prefix",
"targetPrefix": "$(DATE)/MyDocuments/",
"overwriteRule": "never-overwrite",
"aclSettings": "none",
"storageClass": "copy-from-source"
}