Mobile

public struct Mobile

Client object for interacting with AWS Mobile service.

AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


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

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


                    
                    
                    createProject(_:)

Creates an AWS Mobile Hub project.

Declaration

Swift

public func createProject(_ input: CreateProjectRequest) -> EventLoopFuture<CreateProjectResult>


                    
                    
                    deleteProject(_:)

Delets a project in AWS Mobile Hub.

Declaration

Swift

public func deleteProject(_ input: DeleteProjectRequest) -> EventLoopFuture<DeleteProjectResult>


                    
                    
                    describeBundle(_:)

Get the bundle details for the requested bundle id.

Declaration

Swift

public func describeBundle(_ input: DescribeBundleRequest) -> EventLoopFuture<DescribeBundleResult>


                    
                    
                    describeProject(_:)

Gets details about a project in AWS Mobile Hub.

Declaration

Swift

public func describeProject(_ input: DescribeProjectRequest) -> EventLoopFuture<DescribeProjectResult>

exportBundle(_:)
Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
Declaration
Swift

public func exportBundle(_ input: ExportBundleRequest) -> EventLoopFuture<ExportBundleResult>
exportProject(_:)
Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.
Declaration
Swift

public func exportProject(_ input: ExportProjectRequest) -> EventLoopFuture<ExportProjectResult>


                    
                    
                    listBundles(_:)

List all available bundles.

Declaration

Swift

public func listBundles(_ input: ListBundlesRequest) -> EventLoopFuture<ListBundlesResult>


                    
                    
                    listProjects(_:)

Lists projects in AWS Mobile Hub.

Declaration

Swift

public func listProjects(_ input: ListProjectsRequest) -> EventLoopFuture<ListProjectsResult>


                    
                    
                    updateProject(_:)

Update an existing project.

Declaration

Swift

public func updateProject(_ input: UpdateProjectRequest) -> EventLoopFuture<UpdateProjectResult>

Paginators


                    
                    
                    listBundlesPaginator(_:onPage:)

List all available bundles.

Declaration

Swift

public func listBundlesPaginator(_ input: ListBundlesRequest, onPage: @escaping (ListBundlesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listProjectsPaginator(_:onPage:)

Lists projects in AWS Mobile Hub.

Declaration

Swift

public func listProjectsPaginator(_ input: ListProjectsRequest, onPage: @escaping (ListProjectsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListBundlesRequest

Undocumented

Declaration

Swift

public struct ListBundlesRequest : AWSShape

extension Mobile.ListBundlesRequest: AWSPaginateStringToken


                    
                    
                    ListProjectsRequest

Undocumented

Declaration

Swift

public struct ListProjectsRequest : AWSShape

extension Mobile.ListProjectsRequest: AWSPaginateStringToken

BundleDetails
Undocumented
See more
Declaration
Swift

public struct BundleDetails : AWSShape
CreateProjectRequest
Undocumented
See more
Declaration
Swift

public struct CreateProjectRequest : AWSShape
CreateProjectResult
Undocumented
See more
Declaration
Swift

public struct CreateProjectResult : AWSShape
DeleteProjectRequest
Undocumented
See more
Declaration
Swift

public struct DeleteProjectRequest : AWSShape
DeleteProjectResult
Undocumented
See more
Declaration
Swift

public struct DeleteProjectResult : AWSShape
DescribeBundleRequest
Undocumented
See more
Declaration
Swift

public struct DescribeBundleRequest : AWSShape
DescribeBundleResult
Undocumented
See more
Declaration
Swift

public struct DescribeBundleResult : AWSShape
DescribeProjectRequest
Undocumented
See more
Declaration
Swift

public struct DescribeProjectRequest : AWSShape
DescribeProjectResult
Undocumented
See more
Declaration
Swift

public struct DescribeProjectResult : AWSShape
ExportBundleRequest
Undocumented
See more
Declaration
Swift

public struct ExportBundleRequest : AWSShape
ExportBundleResult
Undocumented
See more
Declaration
Swift

public struct ExportBundleResult : AWSShape
ExportProjectRequest
Undocumented
See more
Declaration
Swift

public struct ExportProjectRequest : AWSShape
ExportProjectResult
Undocumented
See more
Declaration
Swift

public struct ExportProjectResult : AWSShape
ListBundlesResult
Undocumented
See more
Declaration
Swift

public struct ListBundlesResult : AWSShape
ListProjectsResult
Undocumented
See more
Declaration
Swift

public struct ListProjectsResult : AWSShape
ProjectDetails
Undocumented
See more
Declaration
Swift

public struct ProjectDetails : AWSShape
ProjectSummary
Undocumented
See more
Declaration
Swift

public struct ProjectSummary : AWSShape
Resource
Undocumented
See more
Declaration
Swift

public struct Resource : AWSShape
UpdateProjectRequest
Undocumented
See more
Declaration
Swift

public struct UpdateProjectRequest : AWSShape
UpdateProjectResult
Undocumented
See more
Declaration
Swift

public struct UpdateProjectResult : AWSShape

Enums


                    
                    
                    Platform

Undocumented

Declaration

Swift

public enum Platform : String, CustomStringConvertible, Codable


                    
                    
                    ProjectState

Undocumented

Declaration

Swift

public enum ProjectState : String, CustomStringConvertible, Codable