app_instance_user_endpoints

Creates, updates, deletes, gets or lists an app_instance_user_endpoints resource.

Overview

Name	app_instance_user_endpoints
Type	Resource
Id	aws.chime_sdk_identity.app_instance_user_endpoints

Fields

The following fields are returned by SELECT queries:

describe_app_instance_user_endpoint

Name	Datatype	Description
allow_messages	string	Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages. (ALL, NONE)
app_instance_user_arn	string	The ARN of the AppInstanceUser. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
created_timestamp	string (date-time)	The time at which an AppInstanceUserEndpoint was created.
endpoint_attributes	object	The attributes of an Endpoint.
endpoint_id	string	The unique identifier of the AppInstanceUserEndpoint. (pattern: <code>.*</code>)
endpoint_state	object	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.
last_updated_timestamp	string (date-time)	The time at which an AppInstanceUserEndpoint was last updated.
name	string	The name of the AppInstanceUserEndpoint. (pattern: <code>.*</code>)
resource_arn	string	The ARN of the resource to which the endpoint belongs. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
type	string	The type of the AppInstanceUserEndpoint. (APNS, APNS_SANDBOX, GCM)

list_app_instance_user_endpoints

Name	Datatype	Description
app_instance_user_endpoints	array	The information for each requested AppInstanceUserEndpoint.
next_token	string	The token passed by previous API calls until all requested endpoints are returned. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_app_instance_user_endpoint	select	app_instance_user_arn, endpoint_id, region		Returns the full details of an AppInstanceUserEndpoint.
list_app_instance_user_endpoints	select	app_instance_user_arn, region	max-results, next-token	Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
register_app_instance_user_endpoint	insert	app_instance_user_arn, region, Type, ResourceArn, EndpointAttributes, ClientRequestToken		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.
update_app_instance_user_endpoint	update	app_instance_user_arn, endpoint_id, region		Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.
deregister_app_instance_user_endpoint	delete	app_instance_user_arn, endpoint_id, region		Deregisters an AppInstanceUserEndpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
app_instance_user_arn	string	The ARN of the AppInstanceUser.
endpoint_id	string	The unique identifier of the AppInstanceUserEndpoint.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of endpoints that you want to return.
next-token	string	The token passed by previous API calls until all requested endpoints are returned.

SELECT examples

describe_app_instance_user_endpoint

Returns the full details of an AppInstanceUserEndpoint.

SELECT
allow_messages,
app_instance_user_arn,
created_timestamp,
endpoint_attributes,
endpoint_id,
endpoint_state,
last_updated_timestamp,
name,
resource_arn,
type
FROM aws.chime_sdk_identity.app_instance_user_endpoints
WHERE app_instance_user_arn = '{{ app_instance_user_arn }}' -- required
AND endpoint_id = '{{ endpoint_id }}' -- required
AND region = '{{ region }}' -- required
;

list_app_instance_user_endpoints

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

SELECT
app_instance_user_endpoints,
next_token
FROM aws.chime_sdk_identity.app_instance_user_endpoints
WHERE app_instance_user_arn = '{{ app_instance_user_arn }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

register_app_instance_user_endpoint

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.

INSERT INTO aws.chime_sdk_identity.app_instance_user_endpoints (
Name,
Type,
ResourceArn,
EndpointAttributes,
ClientRequestToken,
AllowMessages,
app_instance_user_arn,
region
)
SELECT 
'{{ Name }}',
'{{ Type }}' /* required */,
'{{ ResourceArn }}' /* required */,
'{{ EndpointAttributes }}' /* required */,
'{{ ClientRequestToken }}' /* required */,
'{{ AllowMessages }}',
'{{ app_instance_user_arn }}',
'{{ region }}'
RETURNING
app_instance_user_arn,
endpoint_id
;

Manifest

# Description fields are for documentation purposes
- name: app_instance_user_endpoints
props:
  - name: app_instance_user_arn
    value: "{{ app_instance_user_arn }}"
    description: Required parameter for the app_instance_user_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_instance_user_endpoints resource.
  - name: Name
    value: "{{ Name }}"
  - name: Type
    value: "{{ Type }}"
    valid_values: ['APNS', 'APNS_SANDBOX', 'GCM']
  - name: ResourceArn
    value: "{{ ResourceArn }}"
  - name: EndpointAttributes
    description: |
      The attributes of an Endpoint.
    value:
      DeviceToken: "{{ DeviceToken }}"
      VoipDeviceToken: "{{ VoipDeviceToken }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: AllowMessages
    value: "{{ AllowMessages }}"
    valid_values: ['ALL', 'NONE']

UPDATE examples

update_app_instance_user_endpoint

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

UPDATE aws.chime_sdk_identity.app_instance_user_endpoints
SET 
Name = '{{ Name }}',
AllowMessages = '{{ AllowMessages }}'
WHERE 
app_instance_user_arn = '{{ app_instance_user_arn }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
AND region = '{{ region }}' --required
RETURNING
app_instance_user_arn,
endpoint_id;

DELETE examples

deregister_app_instance_user_endpoint

Deregisters an AppInstanceUserEndpoint.

DELETE FROM aws.chime_sdk_identity.app_instance_user_endpoints
WHERE app_instance_user_arn = '{{ app_instance_user_arn }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
AND region = '{{ region }}' --required
;