MediaStoreData

public struct MediaStoreData

Client object for interacting with AWS MediaStoreData service.

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service. Objects are the fundamental entities that are stored in AWS Elemental MediaStore.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


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

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


                    
                    
                    deleteObject(_:)

Deletes an object at the specified path.

Declaration

Swift

public func deleteObject(_ input: DeleteObjectRequest) -> EventLoopFuture<DeleteObjectResponse>


                    
                    
                    describeObject(_:)

Gets the headers for an object at the specified path.

Declaration

Swift

public func describeObject(_ input: DescribeObjectRequest) -> EventLoopFuture<DescribeObjectResponse>

getObject(_:)
Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.
Declaration
Swift

public func getObject(_ input: GetObjectRequest) -> EventLoopFuture<GetObjectResponse>
listItems(_:)
Provides a list of metadata entries about folders and objects in the specified folder.
Declaration
Swift

public func listItems(_ input: ListItemsRequest) -> EventLoopFuture<ListItemsResponse>
putObject(_:)
Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.
Declaration
Swift

public func putObject(_ input: PutObjectRequest) -> EventLoopFuture<PutObjectResponse>

Paginators


                    
                    
                    listItemsPaginator(_:onPage:)

Provides a list of metadata entries about folders and objects in the specified folder.

Declaration

Swift

public func listItemsPaginator(_ input: ListItemsRequest, onPage: @escaping (ListItemsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListItemsRequest

Undocumented

Declaration

Swift

public struct ListItemsRequest : AWSShape

extension MediaStoreData.ListItemsRequest: AWSPaginateStringToken

DeleteObjectRequest
Undocumented
See more
Declaration
Swift

public struct DeleteObjectRequest : AWSShape
DeleteObjectResponse
Undocumented
See more
Declaration
Swift

public struct DeleteObjectResponse : AWSShape
DescribeObjectRequest
Undocumented
See more
Declaration
Swift

public struct DescribeObjectRequest : AWSShape
DescribeObjectResponse
Undocumented
See more
Declaration
Swift

public struct DescribeObjectResponse : AWSShape
GetObjectRequest
Undocumented
See more
Declaration
Swift

public struct GetObjectRequest : AWSShape
GetObjectResponse
Undocumented
See more
Declaration
Swift

public struct GetObjectResponse : AWSShape
Item
Undocumented
See more
Declaration
Swift

public struct Item : AWSShape
ListItemsResponse
Undocumented
See more
Declaration
Swift

public struct ListItemsResponse : AWSShape
PutObjectRequest
Undocumented
See more
Declaration
Swift

public struct PutObjectRequest : AWSShape
PutObjectResponse
Undocumented
See more
Declaration
Swift

public struct PutObjectResponse : AWSShape

Enums


                    
                    
                    ItemType

Undocumented

Declaration

Swift

public enum ItemType : String, CustomStringConvertible, Codable


                    
                    
                    StorageClass

Undocumented

Declaration

Swift

public enum StorageClass : String, CustomStringConvertible, Codable


                    
                    
                    UploadAvailability

Undocumented

Declaration

Swift

public enum UploadAvailability : String, CustomStringConvertible, Codable