S3Control

public struct S3Control

Client object for interacting with AWS S3Control service.

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

Member variables

Initialization

  • Initialize the S3Control client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    @discardableResult
public func createAccessPoint(_ input: CreateAccessPointRequest) -> EventLoopFuture<Void>

  • 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: DescribeJob ListJobs UpdateJobPriority UpdateJobStatus

    Declaration

    Swift

    public func createJob(_ input: CreateJobRequest) -> EventLoopFuture<CreateJobResult>

  • Deletes the specified access point.

    Declaration

    Swift

    @discardableResult
public func deleteAccessPoint(_ input: DeleteAccessPointRequest) -> EventLoopFuture<Void>

  • Deletes the access point policy for the specified access point.

    Declaration

    Swift

    @discardableResult
public func deleteAccessPointPolicy(_ input: DeleteAccessPointPolicyRequest) -> EventLoopFuture<Void>

  • 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: CreateJob GetJobTagging PutJobTagging

    Declaration

    Swift

    public func deleteJobTagging(_ input: DeleteJobTaggingRequest) -> EventLoopFuture<DeleteJobTaggingResult>

  • Removes the PublicAccessBlock configuration for an Amazon Web Services account.

    Declaration

    Swift

    @discardableResult
public func deletePublicAccessBlock(_ input: DeletePublicAccessBlockRequest) -> EventLoopFuture<Void>

  • 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: CreateJob ListJobs UpdateJobPriority UpdateJobStatus

    Declaration

    Swift

    public func describeJob(_ input: DescribeJobRequest) -> EventLoopFuture<DescribeJobResult>

  • Returns configuration information about the specified access point.

    Declaration

    Swift

    public func getAccessPoint(_ input: GetAccessPointRequest) -> EventLoopFuture<GetAccessPointResult>

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

    Declaration

    Swift

    public func getAccessPointPolicy(_ input: GetAccessPointPolicyRequest) -> EventLoopFuture<GetAccessPointPolicyResult>

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

    Declaration

    Swift

    public func getAccessPointPolicyStatus(_ input: GetAccessPointPolicyStatusRequest) -> EventLoopFuture<GetAccessPointPolicyStatusResult>

  • 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: CreateJob PutJobTagging DeleteJobTagging

    Declaration

    Swift

    public func getJobTagging(_ input: GetJobTaggingRequest) -> EventLoopFuture<GetJobTaggingResult>

  • Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

    Declaration

    Swift

    public func getPublicAccessBlock(_ input: GetPublicAccessBlockRequest) -> EventLoopFuture<GetPublicAccessBlockOutput>

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

    Declaration

    Swift

    public func listAccessPoints(_ input: ListAccessPointsRequest) -> EventLoopFuture<ListAccessPointsResult>

  • 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: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus

    Declaration

    Swift

    public func listJobs(_ input: ListJobsRequest) -> EventLoopFuture<ListJobsResult>

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

    Declaration

    Swift

    @discardableResult
public func putAccessPointPolicy(_ input: PutAccessPointPolicyRequest) -> EventLoopFuture<Void>

  • 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. 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: CreateJob GetJobTagging DeleteJobTagging

    Declaration

    Swift

    public func putJobTagging(_ input: PutJobTaggingRequest) -> EventLoopFuture<PutJobTaggingResult>

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

    Declaration

    Swift

    @discardableResult
public func putPublicAccessBlock(_ input: PutPublicAccessBlockRequest) -> EventLoopFuture<Void>

  • 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: CreateJob ListJobs DescribeJob UpdateJobStatus

    Declaration

    Swift

    public func updateJobPriority(_ input: UpdateJobPriorityRequest) -> EventLoopFuture<UpdateJobPriorityResult>

  • 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: CreateJob ListJobs DescribeJob UpdateJobStatus

    Declaration

    Swift

    public func updateJobStatus(_ input: UpdateJobStatusRequest) -> EventLoopFuture<UpdateJobStatusResult>

Paginators

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

    Declaration

    Swift

    public func listAccessPointsPaginator(_ input: ListAccessPointsRequest, onPage: @escaping (ListAccessPointsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus

    Declaration

    Swift

    public func listJobsPaginator(_ input: ListJobsRequest, onPage: @escaping (ListJobsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobManifestFieldName : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobManifestFormat : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobReportFormat : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobReportScope : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum NetworkOrigin : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum OperationName : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum RequestedJobStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3CannedAccessControlList : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3GlacierJobTier : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3GranteeTypeIdentifier : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3MetadataDirective : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3ObjectLockLegalHoldStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3ObjectLockMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3ObjectLockRetentionMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3Permission : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3SSEAlgorithm : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3StorageClass : String, CustomStringConvertible, Codable