ChimeSDKIdentity / Client / describe_app_instance_user_endpoint

describe_app_instance_user_endpoint#

ChimeSDKIdentity.Client.describe_app_instance_user_endpoint(**kwargs)#

Returns the full details of an AppInstanceUserEndpoint.

Request Syntax

response = client.describe_app_instance_user_endpoint(
    AppInstanceUserArn='string',
    EndpointId='string'
)

Parameters:

AppInstanceUserArn (string) –
[REQUIRED]

The ARN of the AppInstanceUser.
EndpointId (string) –
[REQUIRED]

The unique identifier of the AppInstanceUserEndpoint.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceUserEndpoint': {
        'AppInstanceUserArn': 'string',
        'EndpointId': 'string',
        'Name': 'string',
        'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
        'ResourceArn': 'string',
        'EndpointAttributes': {
            'DeviceToken': 'string',
            'VoipDeviceToken': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'AllowMessages': 'ALL'|'NONE',
        'EndpointState': {
            'Status': 'ACTIVE'|'INACTIVE',
            'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
        }
    }
}

Response Structure

(dict) –
- AppInstanceUserEndpoint (dict) –
  
  The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.
  - AppInstanceUserArn (string) –
    
    The ARN of the AppInstanceUser.
  - EndpointId (string) –
    
    The unique identifier of the AppInstanceUserEndpoint.
  - Name (string) –
    
    The name of the AppInstanceUserEndpoint.
  - Type (string) –
    
    The type of the AppInstanceUserEndpoint.
  - ResourceArn (string) –
    
    The ARN of the resource to which the endpoint belongs.
  - EndpointAttributes (dict) –
    
    The attributes of an Endpoint.
    - DeviceToken (string) –
      
      The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
    - VoipDeviceToken (string) –
      
      The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
  - CreatedTimestamp (datetime) –
    
    The time at which an AppInstanceUserEndpoint was created.
  - LastUpdatedTimestamp (datetime) –
    
    The time at which an AppInstanceUserEndpoint was last updated.
  - AllowMessages (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.
  - EndpointState (dict) –
    
    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.
    - Status (string) –
      
      Enum that indicates the Status of an AppInstanceUserEndpoint.
    - StatusReason (string) –
      
      The reason for the EndpointStatus.

Exceptions

ChimeSDKIdentity.Client.exceptions.BadRequestException
ChimeSDKIdentity.Client.exceptions.ForbiddenException
ChimeSDKIdentity.Client.exceptions.ThrottledClientException
ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
ChimeSDKIdentity.Client.exceptions.ServiceFailureException