python-botocore/botocore/data/s3control/2018-08-20/service-2.json
2019-08-03 14:08:36 +09:00

1353 lines
42 KiB
JSON

{
"version":"2.0",
"metadata":{
"apiVersion":"2018-08-20",
"endpointPrefix":"s3-control",
"protocol":"rest-xml",
"serviceFullName":"AWS S3 Control",
"serviceId":"S3 Control",
"signatureVersion":"s3v4",
"signingName":"s3",
"uid":"s3control-2018-08-20"
},
"operations":{
"CreateJob":{
"name":"CreateJob",
"http":{
"method":"POST",
"requestUri":"/v20180820/jobs"
},
"input":{
"shape":"CreateJobRequest",
"locationName":"CreateJobRequest",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"output":{"shape":"CreateJobResult"},
"errors":[
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"IdempotencyException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates an Amazon S3 batch operations job.</p>"
},
"DeletePublicAccessBlock":{
"name":"DeletePublicAccessBlock",
"http":{
"method":"DELETE",
"requestUri":"/v20180820/configuration/publicAccessBlock"
},
"input":{"shape":"DeletePublicAccessBlockRequest"},
"documentation":"<p>Deletes the block public access configuration for the specified account.</p>"
},
"DescribeJob":{
"name":"DescribeJob",
"http":{
"method":"GET",
"requestUri":"/v20180820/jobs/{id}"
},
"input":{"shape":"DescribeJobRequest"},
"output":{"shape":"DescribeJobResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Retrieves the configuration parameters and status for a batch operations job.</p>"
},
"GetPublicAccessBlock":{
"name":"GetPublicAccessBlock",
"http":{
"method":"GET",
"requestUri":"/v20180820/configuration/publicAccessBlock"
},
"input":{"shape":"GetPublicAccessBlockRequest"},
"output":{"shape":"GetPublicAccessBlockOutput"},
"errors":[
{"shape":"NoSuchPublicAccessBlockConfiguration"}
],
"documentation":"<p/>"
},
"ListJobs":{
"name":"ListJobs",
"http":{
"method":"GET",
"requestUri":"/v20180820/jobs"
},
"input":{"shape":"ListJobsRequest"},
"output":{"shape":"ListJobsResult"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.</p>"
},
"PutPublicAccessBlock":{
"name":"PutPublicAccessBlock",
"http":{
"method":"PUT",
"requestUri":"/v20180820/configuration/publicAccessBlock"
},
"input":{"shape":"PutPublicAccessBlockRequest"},
"documentation":"<p/>"
},
"UpdateJobPriority":{
"name":"UpdateJobPriority",
"http":{
"method":"POST",
"requestUri":"/v20180820/jobs/{id}/priority"
},
"input":{"shape":"UpdateJobPriorityRequest"},
"output":{"shape":"UpdateJobPriorityResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Updates an existing job's priority.</p>"
},
"UpdateJobStatus":{
"name":"UpdateJobStatus",
"http":{
"method":"POST",
"requestUri":"/v20180820/jobs/{id}/status"
},
"input":{"shape":"UpdateJobStatusRequest"},
"output":{"shape":"UpdateJobStatusResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"},
{"shape":"JobStatusException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>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.</p>"
}
},
"shapes":{
"AccountId":{
"type":"string",
"max":64
},
"BadRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"Boolean":{"type":"boolean"},
"ConfirmationRequired":{"type":"boolean"},
"CreateJobRequest":{
"type":"structure",
"required":[
"AccountId",
"Operation",
"Report",
"ClientRequestToken",
"Manifest",
"Priority",
"RoleArn"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
},
"ConfirmationRequired":{
"shape":"ConfirmationRequired",
"documentation":"<p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>",
"box":true
},
"Operation":{
"shape":"JobOperation",
"documentation":"<p>The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html\">Available Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"Report":{
"shape":"JobReport",
"documentation":"<p>Configuration parameters for the optional job-completion report.</p>"
},
"ClientRequestToken":{
"shape":"NonEmptyMaxLength64String",
"documentation":"<p>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.</p>",
"idempotencyToken":true
},
"Manifest":{
"shape":"JobManifest",
"documentation":"<p>Configuration parameters for the manifest.</p>"
},
"Description":{
"shape":"NonEmptyMaxLength256String",
"documentation":"<p>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.</p>"
},
"Priority":{
"shape":"JobPriority",
"documentation":"<p>The numerical priority for this job. Higher numbers indicate higher priority.</p>",
"box":true
},
"RoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.</p>"
}
}
},
"CreateJobResult":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful <code>Create Job</code> request.</p>"
}
}
},
"DeletePublicAccessBlockRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the AWS account whose block public access configuration you want to delete.</p>",
"location":"header",
"locationName":"x-amz-account-id"
}
}
},
"DescribeJobRequest":{
"type":"structure",
"required":[
"AccountId",
"JobId"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
},
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for the job whose information you want to retrieve.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"DescribeJobResult":{
"type":"structure",
"members":{
"Job":{
"shape":"JobDescriptor",
"documentation":"<p>Contains the configuration parameters and status for the job specified in the <code>Describe Job</code> request.</p>"
}
}
},
"ExceptionMessage":{
"type":"string",
"max":1024,
"min":1
},
"GetPublicAccessBlockOutput":{
"type":"structure",
"members":{
"PublicAccessBlockConfiguration":{
"shape":"PublicAccessBlockConfiguration",
"documentation":"<p/>"
}
},
"payload":"PublicAccessBlockConfiguration"
},
"GetPublicAccessBlockRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
}
}
},
"IAMRoleArn":{
"type":"string",
"max":2048,
"min":1
},
"IdempotencyException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true,
"fault":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"JobArn":{
"type":"string",
"max":1024,
"min":1
},
"JobCreationTime":{"type":"timestamp"},
"JobDescriptor":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for the specified job.</p>"
},
"ConfirmationRequired":{
"shape":"ConfirmationRequired",
"documentation":"<p>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.</p>",
"box":true
},
"Description":{
"shape":"NonEmptyMaxLength256String",
"documentation":"<p>The description for this job, if one was provided in this job's <code>Create Job</code> request.</p>",
"box":true
},
"JobArn":{
"shape":"JobArn",
"documentation":"<p>The Amazon Resource Name (ARN) for this job.</p>",
"box":true
},
"Status":{
"shape":"JobStatus",
"documentation":"<p>The current status of the specified job.</p>"
},
"Manifest":{
"shape":"JobManifest",
"documentation":"<p>The configuration information for the specified job's manifest object.</p>",
"box":true
},
"Operation":{
"shape":"JobOperation",
"documentation":"<p>The operation that the specified job is configured to execute on the objects listed in the manifest.</p>",
"box":true
},
"Priority":{
"shape":"JobPriority",
"documentation":"<p>The priority of the specified job.</p>"
},
"ProgressSummary":{
"shape":"JobProgressSummary",
"documentation":"<p>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.</p>",
"box":true
},
"StatusUpdateReason":{
"shape":"JobStatusUpdateReason",
"documentation":"<p/>",
"box":true
},
"FailureReasons":{
"shape":"JobFailureList",
"documentation":"<p>If the specified job failed, this field contains information describing the failure.</p>",
"box":true
},
"Report":{
"shape":"JobReport",
"documentation":"<p>Contains the configuration information for the job-completion report if you requested one in the <code>Create Job</code> request.</p>",
"box":true
},
"CreationTime":{
"shape":"JobCreationTime",
"documentation":"<p>A timestamp indicating when this job was created.</p>"
},
"TerminationDate":{
"shape":"JobTerminationDate",
"documentation":"<p>A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.</p>",
"box":true
},
"RoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.</p>",
"box":true
},
"SuspendedDate":{
"shape":"SuspendedDate",
"documentation":"<p>The timestamp when this job was suspended, if it has been suspended.</p>",
"box":true
},
"SuspendedCause":{
"shape":"SuspendedCause",
"documentation":"<p>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 <code>Suspended</code> state to await confirmation before running. After you confirm the job, it automatically exits the <code>Suspended</code> state.</p>",
"box":true
}
},
"documentation":"<p>A container element for the job configuration and status information returned by a <code>Describe Job</code> request.</p>"
},
"JobFailure":{
"type":"structure",
"members":{
"FailureCode":{
"shape":"JobFailureCode",
"documentation":"<p>The failure code, if any, for the specified job.</p>"
},
"FailureReason":{
"shape":"JobFailureReason",
"documentation":"<p>The failure reason, if any, for the specified job.</p>"
}
},
"documentation":"<p>If this job failed, this element indicates why the job failed.</p>"
},
"JobFailureCode":{
"type":"string",
"max":64,
"min":1
},
"JobFailureList":{
"type":"list",
"member":{"shape":"JobFailure"}
},
"JobFailureReason":{
"type":"string",
"max":256,
"min":1
},
"JobId":{
"type":"string",
"max":36,
"min":5
},
"JobListDescriptor":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for the specified job.</p>"
},
"Description":{
"shape":"NonEmptyMaxLength256String",
"documentation":"<p>The user-specified description that was included in the specified job's <code>Create Job</code> request.</p>"
},
"Operation":{
"shape":"OperationName",
"documentation":"<p>The operation that the specified job is configured to run on each object listed in the manifest.</p>"
},
"Priority":{
"shape":"JobPriority",
"documentation":"<p>The current priority for the specified job.</p>"
},
"Status":{
"shape":"JobStatus",
"documentation":"<p>The specified job's current status.</p>"
},
"CreationTime":{
"shape":"JobCreationTime",
"documentation":"<p>A timestamp indicating when the specified job was created.</p>"
},
"TerminationDate":{
"shape":"JobTerminationDate",
"documentation":"<p>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.</p>"
},
"ProgressSummary":{
"shape":"JobProgressSummary",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Contains the configuration and status information for a single job retrieved as part of a job list.</p>"
},
"JobListDescriptorList":{
"type":"list",
"member":{"shape":"JobListDescriptor"}
},
"JobManifest":{
"type":"structure",
"required":[
"Spec",
"Location"
],
"members":{
"Spec":{
"shape":"JobManifestSpec",
"documentation":"<p>Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.</p>"
},
"Location":{
"shape":"JobManifestLocation",
"documentation":"<p>Contains the information required to locate the specified job's manifest.</p>"
}
},
"documentation":"<p>Contains the configuration information for a job's manifest.</p>"
},
"JobManifestFieldList":{
"type":"list",
"member":{"shape":"JobManifestFieldName"}
},
"JobManifestFieldName":{
"type":"string",
"enum":[
"Ignore",
"Bucket",
"Key",
"VersionId"
]
},
"JobManifestFormat":{
"type":"string",
"enum":[
"S3BatchOperations_CSV_20180820",
"S3InventoryReport_CSV_20161130"
]
},
"JobManifestLocation":{
"type":"structure",
"required":[
"ObjectArn",
"ETag"
],
"members":{
"ObjectArn":{
"shape":"S3KeyArnString",
"documentation":"<p>The Amazon Resource Name (ARN) for a manifest object.</p>"
},
"ObjectVersionId":{
"shape":"S3ObjectVersionId",
"documentation":"<p>The optional version ID to identify a specific version of the manifest object.</p>",
"box":true
},
"ETag":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p>The ETag for the specified manifest object.</p>"
}
},
"documentation":"<p>Contains the information required to locate a manifest object.</p>"
},
"JobManifestSpec":{
"type":"structure",
"required":["Format"],
"members":{
"Format":{
"shape":"JobManifestFormat",
"documentation":"<p>Indicates which of the available formats the specified manifest uses.</p>"
},
"Fields":{
"shape":"JobManifestFieldList",
"documentation":"<p>If the specified manifest object is in the <code>S3BatchOperations_CSV_20180820</code> format, this element describes which columns contain the required data.</p>",
"box":true
}
},
"documentation":"<p>Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.</p>"
},
"JobNumberOfTasksFailed":{
"type":"long",
"min":0
},
"JobNumberOfTasksSucceeded":{
"type":"long",
"min":0
},
"JobOperation":{
"type":"structure",
"members":{
"LambdaInvoke":{
"shape":"LambdaInvokeOperation",
"documentation":"<p>Directs the specified job to invoke an AWS Lambda function on each object in the manifest.</p>",
"box":true
},
"S3PutObjectCopy":{
"shape":"S3CopyObjectOperation",
"documentation":"<p>Directs the specified job to execute a PUT Copy object call on each object in the manifest.</p>",
"box":true
},
"S3PutObjectAcl":{
"shape":"S3SetObjectAclOperation",
"documentation":"<p>Directs the specified job to execute a PUT Object acl call on each object in the manifest.</p>",
"box":true
},
"S3PutObjectTagging":{
"shape":"S3SetObjectTaggingOperation",
"documentation":"<p>Directs the specified job to execute a PUT Object tagging call on each object in the manifest.</p>",
"box":true
},
"S3InitiateRestoreObject":{
"shape":"S3InitiateRestoreObjectOperation",
"documentation":"<p>Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.</p>",
"box":true
}
},
"documentation":"<p>The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html\">Available Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"JobPriority":{
"type":"integer",
"max":2147483647,
"min":0
},
"JobProgressSummary":{
"type":"structure",
"members":{
"TotalNumberOfTasks":{
"shape":"JobTotalNumberOfTasks",
"documentation":"<p/>",
"box":true
},
"NumberOfTasksSucceeded":{
"shape":"JobNumberOfTasksSucceeded",
"documentation":"<p/>",
"box":true
},
"NumberOfTasksFailed":{
"shape":"JobNumberOfTasksFailed",
"documentation":"<p/>",
"box":true
}
},
"documentation":"<p>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.</p>"
},
"JobReport":{
"type":"structure",
"required":["Enabled"],
"members":{
"Bucket":{
"shape":"S3BucketArnString",
"documentation":"<p>The bucket where specified job-completion report will be stored.</p>",
"box":true
},
"Format":{
"shape":"JobReportFormat",
"documentation":"<p>The format of the specified job-completion report.</p>",
"box":true
},
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the specified job will generate a job-completion report.</p>"
},
"Prefix":{
"shape":"ReportPrefixString",
"documentation":"<p>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 &lt;prefix&gt;/job-&lt;job-id&gt;/report.json.</p>",
"box":true
},
"ReportScope":{
"shape":"JobReportScope",
"documentation":"<p>Indicates whether the job-completion report will include details of all tasks or only failed tasks.</p>",
"box":true
}
},
"documentation":"<p>Contains the configuration parameters for a job-completion report.</p>"
},
"JobReportFormat":{
"type":"string",
"enum":["Report_CSV_20180820"]
},
"JobReportScope":{
"type":"string",
"enum":[
"AllTasks",
"FailedTasksOnly"
]
},
"JobStatus":{
"type":"string",
"enum":[
"Active",
"Cancelled",
"Cancelling",
"Complete",
"Completing",
"Failed",
"Failing",
"New",
"Paused",
"Pausing",
"Preparing",
"Ready",
"Suspended"
]
},
"JobStatusException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"JobStatusList":{
"type":"list",
"member":{"shape":"JobStatus"}
},
"JobStatusUpdateReason":{
"type":"string",
"max":256,
"min":1
},
"JobTerminationDate":{"type":"timestamp"},
"JobTotalNumberOfTasks":{
"type":"long",
"min":0
},
"KmsKeyArnString":{
"type":"string",
"max":2000,
"min":1
},
"LambdaInvokeOperation":{
"type":"structure",
"members":{
"FunctionArn":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p>The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.</p>"
}
},
"documentation":"<p>Contains the configuration parameters for a <code>Lambda Invoke</code> operation.</p>"
},
"ListJobsRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
},
"JobStatuses":{
"shape":"JobStatusList",
"documentation":"<p>The <code>List Jobs</code> request returns jobs that match the statuses listed in this element.</p>",
"location":"querystring",
"locationName":"jobStatuses"
},
"NextToken":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p>A pagination token to request the next page of results. Use the token that Amazon S3 returned in the <code>NextToken</code> element of the <code>ListJobsResult</code> from the previous <code>List Jobs</code> request.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of jobs that Amazon S3 will include in the <code>List Jobs</code> response. If there are more jobs than this number, the response will include a pagination token in the <code>NextToken</code> field to enable you to retrieve the next page of results.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListJobsResult":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p>If the <code>List Jobs</code> request produced more than the maximum number of results, you can pass this value into a subsequent <code>List Jobs</code> request in order to retrieve the next page of results.</p>"
},
"Jobs":{
"shape":"JobListDescriptorList",
"documentation":"<p>The list of current jobs and jobs that have ended within the last 30 days.</p>"
}
}
},
"MaxLength1024String":{
"type":"string",
"max":1024
},
"MaxResults":{
"type":"integer",
"max":1000,
"min":1
},
"NoSuchPublicAccessBlockConfiguration":{
"type":"structure",
"members":{
"Message":{"shape":"NoSuchPublicAccessBlockConfigurationMessage"}
},
"documentation":"<p/>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchPublicAccessBlockConfigurationMessage":{"type":"string"},
"NonEmptyMaxLength1024String":{
"type":"string",
"max":1024,
"min":1
},
"NonEmptyMaxLength2048String":{
"type":"string",
"max":2048,
"min":1
},
"NonEmptyMaxLength256String":{
"type":"string",
"max":256,
"min":1
},
"NonEmptyMaxLength64String":{
"type":"string",
"max":64,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"OperationName":{
"type":"string",
"enum":[
"LambdaInvoke",
"S3PutObjectCopy",
"S3PutObjectAcl",
"S3PutObjectTagging",
"S3InitiateRestoreObject"
]
},
"PublicAccessBlockConfiguration":{
"type":"structure",
"members":{
"BlockPublicAcls":{
"shape":"Setting",
"documentation":"<p/>",
"locationName":"BlockPublicAcls"
},
"IgnorePublicAcls":{
"shape":"Setting",
"documentation":"<p/>",
"locationName":"IgnorePublicAcls"
},
"BlockPublicPolicy":{
"shape":"Setting",
"documentation":"<p/>",
"locationName":"BlockPublicPolicy"
},
"RestrictPublicBuckets":{
"shape":"Setting",
"documentation":"<p/>",
"locationName":"RestrictPublicBuckets"
}
},
"documentation":"<p/>"
},
"PutPublicAccessBlockRequest":{
"type":"structure",
"required":[
"PublicAccessBlockConfiguration",
"AccountId"
],
"members":{
"PublicAccessBlockConfiguration":{
"shape":"PublicAccessBlockConfiguration",
"documentation":"<p/>",
"locationName":"PublicAccessBlockConfiguration",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
}
},
"payload":"PublicAccessBlockConfiguration"
},
"ReportPrefixString":{
"type":"string",
"max":512,
"min":1
},
"RequestedJobStatus":{
"type":"string",
"enum":[
"Cancelled",
"Ready"
]
},
"S3AccessControlList":{
"type":"structure",
"required":["Owner"],
"members":{
"Owner":{
"shape":"S3ObjectOwner",
"documentation":"<p/>"
},
"Grants":{
"shape":"S3GrantList",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"S3AccessControlPolicy":{
"type":"structure",
"members":{
"AccessControlList":{
"shape":"S3AccessControlList",
"documentation":"<p/>",
"box":true
},
"CannedAccessControlList":{
"shape":"S3CannedAccessControlList",
"documentation":"<p/>",
"box":true
}
},
"documentation":"<p/>"
},
"S3BucketArnString":{
"type":"string",
"max":128,
"min":1
},
"S3CannedAccessControlList":{
"type":"string",
"enum":[
"private",
"public-read",
"public-read-write",
"aws-exec-read",
"authenticated-read",
"bucket-owner-read",
"bucket-owner-full-control"
]
},
"S3ContentLength":{
"type":"long",
"min":0
},
"S3CopyObjectOperation":{
"type":"structure",
"members":{
"TargetResource":{
"shape":"S3BucketArnString",
"documentation":"<p/>"
},
"CannedAccessControlList":{
"shape":"S3CannedAccessControlList",
"documentation":"<p/>",
"box":true
},
"AccessControlGrants":{
"shape":"S3GrantList",
"documentation":"<p/>",
"box":true
},
"MetadataDirective":{
"shape":"S3MetadataDirective",
"documentation":"<p/>"
},
"ModifiedSinceConstraint":{
"shape":"TimeStamp",
"documentation":"<p/>"
},
"NewObjectMetadata":{
"shape":"S3ObjectMetadata",
"documentation":"<p/>"
},
"NewObjectTagging":{
"shape":"S3TagSet",
"documentation":"<p/>"
},
"RedirectLocation":{
"shape":"NonEmptyMaxLength2048String",
"documentation":"<p/>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p/>"
},
"StorageClass":{
"shape":"S3StorageClass",
"documentation":"<p/>"
},
"UnModifiedSinceConstraint":{
"shape":"TimeStamp",
"documentation":"<p/>"
},
"SSEAwsKmsKeyId":{
"shape":"KmsKeyArnString",
"documentation":"<p/>"
},
"TargetKeyPrefix":{"shape":"NonEmptyMaxLength1024String"},
"ObjectLockLegalHoldStatus":{"shape":"S3ObjectLockLegalHoldStatus"},
"ObjectLockMode":{"shape":"S3ObjectLockMode"},
"ObjectLockRetainUntilDate":{"shape":"TimeStamp"}
},
"documentation":"<p>Contains the configuration parameters for a PUT Copy object operation. Amazon S3 batch operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html\">PUT Object - Copy</a>.</p>"
},
"S3ExpirationInDays":{
"type":"integer",
"min":0
},
"S3GlacierJobTier":{
"type":"string",
"enum":[
"BULK",
"STANDARD"
]
},
"S3Grant":{
"type":"structure",
"members":{
"Grantee":{
"shape":"S3Grantee",
"documentation":"<p/>"
},
"Permission":{
"shape":"S3Permission",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"S3GrantList":{
"type":"list",
"member":{"shape":"S3Grant"}
},
"S3Grantee":{
"type":"structure",
"members":{
"TypeIdentifier":{
"shape":"S3GranteeTypeIdentifier",
"documentation":"<p/>"
},
"Identifier":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>",
"box":true
},
"DisplayName":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"S3GranteeTypeIdentifier":{
"type":"string",
"enum":[
"id",
"emailAddress",
"uri"
]
},
"S3InitiateRestoreObjectOperation":{
"type":"structure",
"members":{
"ExpirationInDays":{
"shape":"S3ExpirationInDays",
"documentation":"<p/>"
},
"GlacierJobTier":{
"shape":"S3GlacierJobTier",
"documentation":"<p/>"
}
},
"documentation":"<p>Contains the configuration parameters for an Initiate Glacier Restore job. Amazon S3 batch operations passes each value through to the underlying POST Object restore API. For more information about the parameters for this operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request\">Restoring Archives</a>.</p>"
},
"S3KeyArnString":{
"type":"string",
"max":2000,
"min":1
},
"S3MetadataDirective":{
"type":"string",
"enum":[
"COPY",
"REPLACE"
]
},
"S3ObjectLockLegalHoldStatus":{
"type":"string",
"enum":[
"OFF",
"ON"
]
},
"S3ObjectLockMode":{
"type":"string",
"enum":[
"COMPLIANCE",
"GOVERNANCE"
]
},
"S3ObjectMetadata":{
"type":"structure",
"members":{
"CacheControl":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"ContentDisposition":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"ContentEncoding":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"ContentLanguage":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"UserMetadata":{
"shape":"S3UserMetadata",
"documentation":"<p/>"
},
"ContentLength":{
"shape":"S3ContentLength",
"documentation":"<p/>",
"box":true
},
"ContentMD5":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"ContentType":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"HttpExpiresDate":{
"shape":"TimeStamp",
"documentation":"<p/>"
},
"RequesterCharged":{
"shape":"Boolean",
"documentation":"<p/>"
},
"SSEAlgorithm":{
"shape":"S3SSEAlgorithm",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"S3ObjectOwner":{
"type":"structure",
"members":{
"ID":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"DisplayName":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"S3ObjectVersionId":{
"type":"string",
"max":2000,
"min":1
},
"S3Permission":{
"type":"string",
"enum":[
"FULL_CONTROL",
"READ",
"WRITE",
"READ_ACP",
"WRITE_ACP"
]
},
"S3SSEAlgorithm":{
"type":"string",
"enum":[
"AES256",
"KMS"
]
},
"S3SetObjectAclOperation":{
"type":"structure",
"members":{
"AccessControlPolicy":{
"shape":"S3AccessControlPolicy",
"documentation":"<p/>"
}
},
"documentation":"<p>Contains the configuration parameters for a Set Object ACL operation. Amazon S3 batch operations passes each value through to the underlying PUT Object acl API. For more information about the parameters for this operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html\">PUT Object acl</a>.</p>"
},
"S3SetObjectTaggingOperation":{
"type":"structure",
"members":{
"TagSet":{
"shape":"S3TagSet",
"documentation":"<p/>"
}
},
"documentation":"<p>Contains the configuration parameters for a Set Object Tagging operation. Amazon S3 batch operations passes each value through to the underlying PUT Object tagging API. For more information about the parameters for this operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html\">PUT Object tagging</a>.</p>"
},
"S3StorageClass":{
"type":"string",
"enum":[
"STANDARD",
"STANDARD_IA",
"ONEZONE_IA",
"GLACIER",
"INTELLIGENT_TIERING",
"DEEP_ARCHIVE"
]
},
"S3Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p/>"
},
"Value":{
"shape":"MaxLength1024String",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"S3TagSet":{
"type":"list",
"member":{"shape":"S3Tag"}
},
"S3UserMetadata":{
"type":"map",
"key":{"shape":"NonEmptyMaxLength1024String"},
"value":{"shape":"MaxLength1024String"},
"max":8192
},
"Setting":{"type":"boolean"},
"SuspendedCause":{
"type":"string",
"max":1024,
"min":1
},
"SuspendedDate":{"type":"timestamp"},
"TimeStamp":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"UpdateJobPriorityRequest":{
"type":"structure",
"required":[
"AccountId",
"JobId",
"Priority"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
},
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for the job whose priority you want to update.</p>",
"location":"uri",
"locationName":"id"
},
"Priority":{
"shape":"JobPriority",
"documentation":"<p>The priority you want to assign to this job.</p>",
"location":"querystring",
"locationName":"priority"
}
}
},
"UpdateJobPriorityResult":{
"type":"structure",
"required":[
"JobId",
"Priority"
],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for the job whose priority Amazon S3 updated.</p>"
},
"Priority":{
"shape":"JobPriority",
"documentation":"<p>The new priority assigned to the specified job.</p>"
}
}
},
"UpdateJobStatusRequest":{
"type":"structure",
"required":[
"AccountId",
"JobId",
"RequestedJobStatus"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"location":"header",
"locationName":"x-amz-account-id"
},
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID of the job whose status you want to update.</p>",
"location":"uri",
"locationName":"id"
},
"RequestedJobStatus":{
"shape":"RequestedJobStatus",
"documentation":"<p>The status that you want to move the specified job to.</p>",
"location":"querystring",
"locationName":"requestedJobStatus"
},
"StatusUpdateReason":{
"shape":"JobStatusUpdateReason",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"statusUpdateReason"
}
}
},
"UpdateJobStatusResult":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID for the job whose status was updated.</p>"
},
"Status":{
"shape":"JobStatus",
"documentation":"<p>The current status for the specified job.</p>"
},
"StatusUpdateReason":{
"shape":"JobStatusUpdateReason",
"documentation":"<p>The reason that the specified job's status was updated.</p>"
}
}
}
},
"documentation":"<p> AWS S3 Control provides access to Amazon S3 control plane operations. </p>"
}