Module Awso_chime_sdk_identity.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule StandardMessages : sig ... end
Sourcemodule TargetedMessages : sig ... end
Sourcemodule EndpointStatus : sig ... end
Sourcemodule EndpointStatusReason : sig ... end
Sourcemodule ChimeArn : sig ... end
Sourcemodule ResourceName : sig ... end
Sourcemodule InvokedBy : sig ... end

Specifies the type of message that triggers a bot.

Sourcemodule LexBotAliasArn : sig ... end
Sourcemodule LexIntentName : sig ... end
Sourcemodule RespondsTo : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule RetentionDays : sig ... end
Sourcemodule Metadata : sig ... end
Sourcemodule NonEmptyResourceName : sig ... end
Sourcemodule UserName : sig ... end
Sourcemodule AllowMessages : sig ... end
Sourcemodule EndpointState : sig ... end

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values: ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty. INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason. INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Sourcemodule SensitiveString1600 : sig ... end
Sourcemodule String64 : sig ... end
Sourcemodule Identity : sig ... end

The details of a user or bot.

Sourcemodule ExpirationCriterion : sig ... end
Sourcemodule ExpirationDays : sig ... end
Sourcemodule LexConfiguration : sig ... end

The configuration for an Amazon Lex V2 bot.

Sourcemodule ErrorCode : sig ... end
Sourcemodule Tag : sig ... end

A tag object containing a key-value pair.

Sourcemodule ChannelRetentionSettings : sig ... end

The details of the retention settings for a channel.

Sourcemodule AppInstanceSummary : sig ... end

Summary of the data for an AppInstance.

Sourcemodule AppInstanceUserSummary : sig ... end

Summary of the details of an AppInstanceUser.

Summary of the details of an AppInstanceUserEndpoint.

Sourcemodule AppInstanceBotSummary : sig ... end

High-level information about an AppInstanceBot.

Sourcemodule AppInstanceAdminSummary : sig ... end

Summary of the details of an AppInstanceAdmin.

Sourcemodule ExpirationSettings : sig ... end

Determines the interval after which an AppInstanceUser is automatically deleted.

Sourcemodule Timestamp : sig ... end
Sourcemodule EndpointAttributes : sig ... end

The attributes of an Endpoint.

Sourcemodule Configuration : sig ... end

A structure that contains configuration data.

Sourcemodule BadRequestException : sig ... end

The input parameters don't match the service's restrictions.

Sourcemodule ConflictException : sig ... end

The request could not be processed because of conflict in the current state of the resource.

Sourcemodule ForbiddenException : sig ... end

The client is permanently forbidden from making the request.

The request exceeds the resource limit.

Sourcemodule ServiceFailureException : sig ... end

The service encountered an unexpected error.

The service is currently unavailable.

Sourcemodule ThrottledClientException : sig ... end

The client exceeded its request rate limit.

The client is not currently authorized to make the request.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TagList : sig ... end
Sourcemodule ClientRequestToken : sig ... end
Sourcemodule SensitiveChimeArn : sig ... end

The details of the data-retention settings for an AppInstance.

Sourcemodule AppInstanceList : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule AppInstanceUserList : sig ... end
Sourcemodule AppInstanceBotList : sig ... end
Sourcemodule AppInstanceAdminList : sig ... end
Sourcemodule AppInstanceUser : sig ... end

The details of an AppInstanceUser.

Sourcemodule AppInstanceUserEndpoint : sig ... end

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Sourcemodule String1600 : sig ... end
Sourcemodule AppInstance : sig ... end

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Sourcemodule AppInstanceBot : sig ... end

An Amazon Lex V2 chat bot created under an AppInstance.

Sourcemodule NotFoundException : sig ... end

One or more of the resources in the request does not exist in the system.

Sourcemodule AppInstanceAdmin : sig ... end

The name and ARN of the admin for the AppInstance.

Sourcemodule UserId : sig ... end

Updates the details of an AppInstanceUser. You can update names and metadata.

Updates the details of an AppInstanceUser. You can update names and metadata.

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

Sourcemodule UpdateAppInstanceResponse : sig ... end

Updates AppInstance metadata.

Sourcemodule UpdateAppInstanceRequest : sig ... end

Updates AppInstance metadata.

Updates the name and metadata of an AppInstanceBot.

Updates the name and metadata of an AppInstanceBot.

Sourcemodule UntagResourceRequest : sig ... end

Removes the specified tags from the specified Amazon Chime SDK identity resource.

Sourcemodule TagResourceRequest : sig ... end

Applies the specified tags to the specified Amazon Chime SDK identity resource.

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

Sets the amount of time in days that a given AppInstance retains data.

Sets the amount of time in days that a given AppInstance retains data.

Lists the tags applied to an Amazon Chime SDK identity resource.

Lists the tags applied to an Amazon Chime SDK identity resource.

Sourcemodule ListAppInstancesResponse : sig ... end

Lists all Amazon Chime AppInstances created under a single AWS account.

Sourcemodule ListAppInstancesRequest : sig ... end

Lists all Amazon Chime AppInstances created under a single AWS account.

List all AppInstanceUsers created under a single AppInstance.

List all AppInstanceUsers created under a single AppInstance.

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Lists all AppInstanceBots created under a single AppInstance.

Lists all AppInstanceBots created under a single AppInstance.

Returns a list of the administrators in the AppInstance.

Returns a list of the administrators in the AppInstance.

Gets the retention settings for an AppInstance.

Gets the retention settings for an AppInstance.

Returns the full details of an AppInstanceUser.

Returns the full details of an AppInstanceUser.

Returns the full details of an AppInstanceUserEndpoint.

Returns the full details of an AppInstanceUserEndpoint.

Returns the full details of an AppInstance.

Returns the full details of an AppInstance.

The AppInstanceBot's information.

The AppInstanceBot's information.

Returns the full details of an AppInstanceAdmin.

Returns the full details of an AppInstanceAdmin.

Deregisters an AppInstanceUserEndpoint.

Deletes an AppInstanceUser.

Sourcemodule DeleteAppInstanceRequest : sig ... end

Deletes an AppInstance and all associated data asynchronously.

Deletes an AppInstanceBot.

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Sourcemodule CreateAppInstanceResponse : sig ... end

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity

Sourcemodule CreateAppInstanceRequest : sig ... end

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.