Structures

The payload of a Hub message

API Category Configuration

Reachability Update

GraphQL Operation Request

GraphQL Request

REST Operation Request

The error format according to https://graphql.github.io/graphql-spec/June2018/#sec-Errors

Analytics category configuration

User specific data

Basic analytics event

Details on where the code has been delivered

Request for resending confirmation code that was generated for update attribute

Request for change password operation

Request for reset password confirmation

Request for confirming sign in flow

Request to confirm the signup flow

Request to confirm a user attribute update

Request for delete user

Request to fetch the devices associated with the signed in user.

Request to fetch the current auth session

Request to fetch the user attributes of the current user

Request to forget a device of the user

Request to remember the current device

Request to resend sign up code

Request to reset password of a user

Request to sign in a user

Request for sign out user

Request for sign up flow

Request to update a single attribute of the signed in user

Request to update multiple user attributes of the signed in user

Request to initiate sign in using a web UI.

Note that this call would also be used for sign up, forgot password, confirm password, and similar flows.

Result for Auth.resetPassword api

Information about a conflict that occurred attempting to sync a local model with a remote model

Registry of ModelListDecoder‘s used to retrieve decoders that can create ModelListProviders to perform List functionality.

General concrete implementation of a ModelIdentifierProtocol

DateUnit for use in adding and subtracting units from Temporal.Date, Temporal.DateTime, and Temporal.Time.

DateUnit uses Calendar.Component under the hood to ensure date oddities are accounted for.

let tomorrow = Temporal.Date.now() + .days(1)
let twoWeeksFromNow = Temporal.Date.now() + .weeks(2)
let nextYear = Temporal.Date.now() + .years(1)

let yesterday = Temporal.Date.now() - .days(1)
let sixMonthsAgo = Temporal.Date.now() - .months(6)

TimeUnit for use in adding and subtracting units from Temporal.DateTime, and Temporal.Time.

TimeUnit uses Calendar.Component under the hood to ensure date oddities are accounted for.

let twoHoursFromNow = Temporal.Time.now() + .hours(1)
let fiveMinutesAgo = Temporal.Time.now() - .minutes(5)
let yesterday = Temporal.Date.now() - .days(1)
let sixMonthsAgo = Temporal.Date.now() - .months(6)

A simple struct that holds pagination information that can be applied queries.

A snapshot of the items from DataStore, the changes since last snapshot, and whether this model has finished syncing and subscriptions are active

Geo category configuration

Convenience filters for common filtering use cases

Convenience typealias defining a closure that can be used to unsubscribe a Hub listener. Although UnsubscribeToken conforms to Hashable, only the id property is considered for equality and hash value; channel is used only for routing an unsubscribe request to the correct HubChannel.

Age range of an entity(faces/celebrities) detected as a result of identify() API

Attribute of an entity identified as a result of identify() API

Gender of an entity(face/celebrity) identified with associated confidence value

Describes the data extracted as key-value pair in an image/document resulting from identify() API e.g The text “Name: John Doe” present in an image/document

Describes a celebrity identified in an image with information about its location(bounding box) and facial features(landmarks)

Celebrity metadata identified as a result of identify() API

Emotion identified in an entity(faces/celebrities) as a result of identify() API with associated EmotionType and confidence value

Result returned as part of identify() API call with IdentifyAction.detectEntities type parameter

Describes the result of interpret() API when the analyzed text contains a person/place

Describes the result for an entity matched in an entity collection created on AWS Rekogniton and detected from identify() API call

Describes a line of text identified in an image as a result of identify() API call

Describes a word identified in an image as a result of identify() API call

Describes a key phrase identified in a text as a result of interpret() API call

Describes the facial feature in a celebrity/entity identified as a result of identify() API

Result describing language identified in a text from interpret() API call

Part of speech identified in a text from interpret() API

Describes the pose of a person identified in an image from identify() API

Sentiment Analysis result for Predictions category

Describes syntactical information resulting from text interpretation as a result of interpret() API

Results are mapped to IdentifyCelebritiesResult when .detectCelebrity in passed in the type: field in identify() API

Results are mapped to IdentifyDocumentTextResult when .form, .table or .all is passed for .detectText in the type: field in identify() API

Results are mapped to IdentifyEntitiesResult when .detectEntities is passed to type: field in identify() API and general entities like facial features, landmarks etc. are needed to be detected

Results are mapped to IdentifyEntityMatchesResult when .detectEntities is passed to type: field in identify() API and matches from your Rekognition Collection need to be identified

Results are mapped to IdentifyLabelsResult when .labels in passed to .detectLabels in the type: field in identify() API

Describes a real world object (e.g., chair, desk) identified in an image

Results are mapped to IdentifyTextResult when .plain is passed for .detectText in the type: field in identify() API

Results are mapped to InterpretResult for interpret() API

Results are mapped to SpeechToTextResult when convert() API is called to convert a text to audio

Results are mapped to TextToSpeechResult when convert() API is called to convert a text to audio

Results are mapped to TranslateTextResult when convert() API is called to translate a text into another language

Configures the Amplify system with sub-configurations for each supported category

Commonly used cross-category error messages.

A context object passed in the HubPayload of all events dispatched to the Hub by an AmplifyOperation. This object can be used to filter on a particular operation.

This is public so plugins can use it to indicate cancellations on arbitrary operations.