DataExchange

public struct DataExchange

Client object for interacting with AWS DataExchange service.

This is the API reference for AWS Data Exchange.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the DataExchange 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

cancelJob(_:)
This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
Declaration
Swift

@discardableResult public func cancelJob(_ input: CancelJobRequest) -> EventLoopFuture<Void>


                    
                    
                    createDataSet(_:)

This operation creates a data set.

Declaration

Swift

public func createDataSet(_ input: CreateDataSetRequest) -> EventLoopFuture<CreateDataSetResponse>


                    
                    
                    createJob(_:)

This operation creates a job.

Declaration

Swift

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


                    
                    
                    createRevision(_:)

This operation creates a revision for a data set.

Declaration

Swift

public func createRevision(_ input: CreateRevisionRequest) -> EventLoopFuture<CreateRevisionResponse>


                    
                    
                    deleteAsset(_:)

This operation deletes an asset.

Declaration

Swift

@discardableResult
public func deleteAsset(_ input: DeleteAssetRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteDataSet(_:)

This operation deletes a data set.

Declaration

Swift

@discardableResult
public func deleteDataSet(_ input: DeleteDataSetRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteRevision(_:)

This operation deletes a revision.

Declaration

Swift

@discardableResult
public func deleteRevision(_ input: DeleteRevisionRequest) -> EventLoopFuture<Void>


                    
                    
                    getAsset(_:)

This operation returns information about an asset.

Declaration

Swift

public func getAsset(_ input: GetAssetRequest) -> EventLoopFuture<GetAssetResponse>


                    
                    
                    getDataSet(_:)

This operation returns information about a data set.

Declaration

Swift

public func getDataSet(_ input: GetDataSetRequest) -> EventLoopFuture<GetDataSetResponse>


                    
                    
                    getJob(_:)

This operation returns information about a job.

Declaration

Swift

public func getJob(_ input: GetJobRequest) -> EventLoopFuture<GetJobResponse>


                    
                    
                    getRevision(_:)

This operation returns information about a revision.

Declaration

Swift

public func getRevision(_ input: GetRevisionRequest) -> EventLoopFuture<GetRevisionResponse>

listDataSetRevisions(_:)
This operation lists a data set’s revisions sorted by CreatedAt in descending order.
Declaration
Swift

public func listDataSetRevisions(_ input: ListDataSetRevisionsRequest) -> EventLoopFuture<ListDataSetRevisionsResponse>
listDataSets(_:)
This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
Declaration
Swift

public func listDataSets(_ input: ListDataSetsRequest) -> EventLoopFuture<ListDataSetsResponse>
listJobs(_:)
This operation lists your jobs sorted by CreatedAt in descending order.
Declaration
Swift

public func listJobs(_ input: ListJobsRequest) -> EventLoopFuture<ListJobsResponse>
listRevisionAssets(_:)
This operation lists a revision’s assets sorted alphabetically in descending order.
Declaration
Swift

public func listRevisionAssets(_ input: ListRevisionAssetsRequest) -> EventLoopFuture<ListRevisionAssetsResponse>


                    
                    
                    listTagsForResource(_:)

This operation lists the tags on the resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    startJob(_:)

This operation starts a job.

Declaration

Swift

public func startJob(_ input: StartJobRequest) -> EventLoopFuture<StartJobResponse>


                    
                    
                    tagResource(_:)

This operation tags a resource.

Declaration

Swift

@discardableResult
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    untagResource(_:)

This operation removes one or more tags from a resource.

Declaration

Swift

@discardableResult
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    updateAsset(_:)

This operation updates an asset.

Declaration

Swift

public func updateAsset(_ input: UpdateAssetRequest) -> EventLoopFuture<UpdateAssetResponse>


                    
                    
                    updateDataSet(_:)

This operation updates a data set.

Declaration

Swift

public func updateDataSet(_ input: UpdateDataSetRequest) -> EventLoopFuture<UpdateDataSetResponse>


                    
                    
                    updateRevision(_:)

This operation updates a revision.

Declaration

Swift

public func updateRevision(_ input: UpdateRevisionRequest) -> EventLoopFuture<UpdateRevisionResponse>

Paginators


                    
                    
                    listDataSetRevisionsPaginator(_:onPage:)

This operation lists a data set’s revisions sorted by CreatedAt in descending order.

Declaration

Swift

public func listDataSetRevisionsPaginator(_ input: ListDataSetRevisionsRequest, onPage: @escaping (ListDataSetRevisionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listDataSetsPaginator(_:onPage:)
This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
Declaration
Swift

public func listDataSetsPaginator(_ input: ListDataSetsRequest, onPage: @escaping (ListDataSetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listJobsPaginator(_:onPage:)

This operation lists your jobs sorted by CreatedAt in descending order.

Declaration

Swift

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


                    
                    
                    listRevisionAssetsPaginator(_:onPage:)

This operation lists a revision’s assets sorted alphabetically in descending order.

Declaration

Swift

public func listRevisionAssetsPaginator(_ input: ListRevisionAssetsRequest, onPage: @escaping (ListRevisionAssetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListDataSetRevisionsRequest

Undocumented

Declaration

Swift

public struct ListDataSetRevisionsRequest : AWSShape

extension DataExchange.ListDataSetRevisionsRequest: AWSPaginateStringToken


                    
                    
                    ListDataSetsRequest

Undocumented

Declaration

Swift

public struct ListDataSetsRequest : AWSShape

extension DataExchange.ListDataSetsRequest: AWSPaginateStringToken


                    
                    
                    ListJobsRequest

Undocumented

Declaration

Swift

public struct ListJobsRequest : AWSShape

extension DataExchange.ListJobsRequest: AWSPaginateStringToken


                    
                    
                    ListRevisionAssetsRequest

Undocumented

Declaration

Swift

public struct ListRevisionAssetsRequest : AWSShape

extension DataExchange.ListRevisionAssetsRequest: AWSPaginateStringToken

AssetDestinationEntry
Undocumented
See more
Declaration
Swift

public struct AssetDestinationEntry : AWSShape
AssetDetails
Undocumented
See more
Declaration
Swift

public struct AssetDetails : AWSShape
AssetEntry
Undocumented
See more
Declaration
Swift

public struct AssetEntry : AWSShape
AssetSourceEntry
Undocumented
See more
Declaration
Swift

public struct AssetSourceEntry : AWSShape
CancelJobRequest
Undocumented
See more
Declaration
Swift

public struct CancelJobRequest : AWSShape
CreateDataSetRequest
Undocumented
See more
Declaration
Swift

public struct CreateDataSetRequest : AWSShape
CreateDataSetResponse
Undocumented
See more
Declaration
Swift

public struct CreateDataSetResponse : AWSShape
CreateJobRequest
Undocumented
See more
Declaration
Swift

public struct CreateJobRequest : AWSShape
CreateJobResponse
Undocumented
See more
Declaration
Swift

public struct CreateJobResponse : AWSShape
CreateRevisionRequest
Undocumented
See more
Declaration
Swift

public struct CreateRevisionRequest : AWSShape
CreateRevisionResponse
Undocumented
See more
Declaration
Swift

public struct CreateRevisionResponse : AWSShape
DataSetEntry
Undocumented
See more
Declaration
Swift

public struct DataSetEntry : AWSShape
DeleteAssetRequest
Undocumented
See more
Declaration
Swift

public struct DeleteAssetRequest : AWSShape
DeleteDataSetRequest
Undocumented
See more
Declaration
Swift

public struct DeleteDataSetRequest : AWSShape
DeleteRevisionRequest
Undocumented
See more
Declaration
Swift

public struct DeleteRevisionRequest : AWSShape
Details
Undocumented
See more
Declaration
Swift

public struct Details : AWSShape
ExportAssetToSignedUrlRequestDetails
Undocumented
See more
Declaration
Swift

public struct ExportAssetToSignedUrlRequestDetails : AWSShape
ExportAssetToSignedUrlResponseDetails
Undocumented
See more
Declaration
Swift

public struct ExportAssetToSignedUrlResponseDetails : AWSShape
ExportAssetsToS3RequestDetails
Undocumented
See more
Declaration
Swift

public struct ExportAssetsToS3RequestDetails : AWSShape
ExportAssetsToS3ResponseDetails
Undocumented
See more
Declaration
Swift

public struct ExportAssetsToS3ResponseDetails : AWSShape
ExportServerSideEncryption
Undocumented
See more
Declaration
Swift

public struct ExportServerSideEncryption : AWSShape
GetAssetRequest
Undocumented
See more
Declaration
Swift

public struct GetAssetRequest : AWSShape
GetAssetResponse
Undocumented
See more
Declaration
Swift

public struct GetAssetResponse : AWSShape
GetDataSetRequest
Undocumented
See more
Declaration
Swift

public struct GetDataSetRequest : AWSShape
GetDataSetResponse
Undocumented
See more
Declaration
Swift

public struct GetDataSetResponse : AWSShape
GetJobRequest
Undocumented
See more
Declaration
Swift

public struct GetJobRequest : AWSShape
GetJobResponse
Undocumented
See more
Declaration
Swift

public struct GetJobResponse : AWSShape
GetRevisionRequest
Undocumented
See more
Declaration
Swift

public struct GetRevisionRequest : AWSShape
GetRevisionResponse
Undocumented
See more
Declaration
Swift

public struct GetRevisionResponse : AWSShape
ImportAssetFromSignedUrlJobErrorDetails
Undocumented
See more
Declaration
Swift

public struct ImportAssetFromSignedUrlJobErrorDetails : AWSShape
ImportAssetFromSignedUrlRequestDetails
Undocumented
See more
Declaration
Swift

public struct ImportAssetFromSignedUrlRequestDetails : AWSShape
ImportAssetFromSignedUrlResponseDetails
Undocumented
See more
Declaration
Swift

public struct ImportAssetFromSignedUrlResponseDetails : AWSShape
ImportAssetsFromS3RequestDetails
Undocumented
See more
Declaration
Swift

public struct ImportAssetsFromS3RequestDetails : AWSShape
ImportAssetsFromS3ResponseDetails
Undocumented
See more
Declaration
Swift

public struct ImportAssetsFromS3ResponseDetails : AWSShape
JobEntry
Undocumented
See more
Declaration
Swift

public struct JobEntry : AWSShape
JobError
Undocumented
See more
Declaration
Swift

public struct JobError : AWSShape
ListDataSetRevisionsResponse
Undocumented
See more
Declaration
Swift

public struct ListDataSetRevisionsResponse : AWSShape
ListDataSetsResponse
Undocumented
See more
Declaration
Swift

public struct ListDataSetsResponse : AWSShape
ListJobsResponse
Undocumented
See more
Declaration
Swift

public struct ListJobsResponse : AWSShape
ListRevisionAssetsResponse
Undocumented
See more
Declaration
Swift

public struct ListRevisionAssetsResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
OriginDetails
Undocumented
See more
Declaration
Swift

public struct OriginDetails : AWSShape
RequestDetails
Undocumented
See more
Declaration
Swift

public struct RequestDetails : AWSShape
ResponseDetails
Undocumented
See more
Declaration
Swift

public struct ResponseDetails : AWSShape
RevisionEntry
Undocumented
See more
Declaration
Swift

public struct RevisionEntry : AWSShape
S3SnapshotAsset
Undocumented
See more
Declaration
Swift

public struct S3SnapshotAsset : AWSShape
StartJobRequest
Undocumented
See more
Declaration
Swift

public struct StartJobRequest : AWSShape
StartJobResponse
Undocumented
See more
Declaration
Swift

public struct StartJobResponse : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UpdateAssetRequest
Undocumented
See more
Declaration
Swift

public struct UpdateAssetRequest : AWSShape
UpdateAssetResponse
Undocumented
See more
Declaration
Swift

public struct UpdateAssetResponse : AWSShape
UpdateDataSetRequest
Undocumented
See more
Declaration
Swift

public struct UpdateDataSetRequest : AWSShape
UpdateDataSetResponse
Undocumented
See more
Declaration
Swift

public struct UpdateDataSetResponse : AWSShape
UpdateRevisionRequest
Undocumented
See more
Declaration
Swift

public struct UpdateRevisionRequest : AWSShape
UpdateRevisionResponse
Undocumented
See more
Declaration
Swift

public struct UpdateRevisionResponse : AWSShape

Enums


                    
                    
                    AssetType

Undocumented

Declaration

Swift

public enum AssetType : String, CustomStringConvertible, Codable


                    
                    
                    Code

Undocumented

Declaration

Swift

public enum Code : String, CustomStringConvertible, Codable


                    
                    
                    JobErrorLimitName

Undocumented

Declaration

Swift

public enum JobErrorLimitName : String, CustomStringConvertible, Codable


                    
                    
                    JobErrorResourceTypes

Undocumented

Declaration

Swift

public enum JobErrorResourceTypes : String, CustomStringConvertible, Codable


                    
                    
                    Origin

Undocumented

Declaration

Swift

public enum Origin : String, CustomStringConvertible, Codable


                    
                    
                    ServerSideEncryptionTypes

Undocumented

Declaration

Swift

public enum ServerSideEncryptionTypes : String, CustomStringConvertible, Codable


                    
                    
                    State

Undocumented

Declaration

Swift

public enum State : String, CustomStringConvertible, Codable


                    
                    
                    Type

Undocumented

Declaration

Swift

public enum `Type` : String, CustomStringConvertible, Codable