AWS API Changes

2021/10/26 - Amazon Chime SDK Identity - 8 new api methods

Changes The Amazon Chime SDK now supports push notifications through Amazon Pinpoint

DeregisterAppInstanceUserEndpoint (new)

Link ¶

Deregisters an AppInstanceUserEndpoint.

Request Syntax

client.deregister_app_instance_user_endpoint(
    AppInstanceUserArn='string',
    EndpointId='string'
)

type AppInstanceUserArn:

string

param AppInstanceUserArn:

[REQUIRED]

The ARN of the AppInstanceUser.

type EndpointId:

string

param EndpointId:

[REQUIRED]

The unique identifier of the AppInstanceUserEndpoint.

returns:

None

ListAppInstanceUserEndpoints (new)

Link ¶

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

See also: AWS API Documentation

Request Syntax

client.list_app_instance_user_endpoints(
    AppInstanceUserArn='string',
    MaxResults=123,
    NextToken='string'
)

type AppInstanceUserArn:

string

param AppInstanceUserArn:

[REQUIRED]

The ARN of the AppInstanceUser.

type MaxResults:

integer

param MaxResults:

The maximum number of endpoints that you want to return.

type NextToken:

string

param NextToken:

The token passed by previous API calls until all requested endpoints are returned.

rtype:

dict

returns:

Response Syntax

{
    'AppInstanceUserEndpoints': [
        {
            'AppInstanceUserArn': 'string',
            'EndpointId': 'string',
            'Name': 'string',
            'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
            'AllowMessages': 'ALL'|'NONE',
            'EndpointState': {
                'Status': 'ACTIVE'|'INACTIVE',
                'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AppInstanceUserEndpoints (list) --
  
  The information for each requested AppInstanceUserEndpoint.
  - (dict) --
    
    Summary of the details of an AppInstanceUserEndpoint.
    - 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.
    - AllowMessages (string) --
      
      BBoolean 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 represent the state of an AppInstanceUserEndpoint.
      - Status (string) --
        
        Enum that indicates the Status of an AppInstanceUserEndpoint.
      - StatusReason (string) --
        
        The reason for the EndpointStatus.
- NextToken (string) --
  
  The token passed by previous API calls until all requested endpoints are returned.

TagResource (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

type Tags:

list

param Tags:

[REQUIRED]

The tag key-value pairs.

(dict) --

A tag object containing a key-value pair.
- Key (string) -- [REQUIRED]
  
  The key in a tag.
- Value (string) -- [REQUIRED]
  
  The value in a tag.

returns:

None

UntagResource (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

type TagKeys:

list

param TagKeys:

[REQUIRED]

The tag keys.

(string) --

returns:

None

DescribeAppInstanceUserEndpoint (new)

Link ¶

Returns the full details of an AppInstanceUserEndpoint.

See also: AWS API Documentation

Request Syntax

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

type AppInstanceUserArn:

string

param AppInstanceUserArn:

[REQUIRED]

The ARN of the AppInstanceUser.

type EndpointId:

string

param EndpointId:

[REQUIRED]

The unique identifier of the AppInstanceUserEndpoint.

rtype:

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.

ListTagsForResource (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The ARN of the resource.

rtype:

dict

returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  
  The tag key-value pairs.
  - (dict) --
    
    A tag object containing a key-value pair.
    - Key (string) --
      
      The key in a tag.
    - Value (string) --
      
      The value in a tag.

RegisterAppInstanceUserEndpoint (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.register_app_instance_user_endpoint(
    AppInstanceUserArn='string',
    Name='string',
    Type='APNS'|'APNS_SANDBOX'|'GCM',
    ResourceArn='string',
    EndpointAttributes={
        'DeviceToken': 'string',
        'VoipDeviceToken': 'string'
    },
    ClientRequestToken='string',
    AllowMessages='ALL'|'NONE'
)

type AppInstanceUserArn:

string

param AppInstanceUserArn:

[REQUIRED]

The ARN of the AppInstanceUser.

type Name:

string

param Name:

The name of the AppInstanceUserEndpoint.

type Type:

string

param Type:

[REQUIRED]

The type of the AppInstanceUserEndpoint. Supported types:

APNS: The mobile notification service for an Apple device.
APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The ARN of the resource to which the endpoint belongs.

type EndpointAttributes:

dict

param EndpointAttributes:

[REQUIRED]

The attributes of an Endpoint.

DeviceToken (string) -- [REQUIRED]

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.

type ClientRequestToken:

string

param ClientRequestToken:

[REQUIRED]

The idempotency token for each client request.

This field is autopopulated if not provided.

type AllowMessages:

string

param AllowMessages:

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

rtype:

dict

returns:

Response Syntax

{
    'AppInstanceUserArn': 'string',
    'EndpointId': 'string'
}

Response Structure

(dict) --
- AppInstanceUserArn (string) --
  
  The ARN of the AppInstanceUser.
- EndpointId (string) --
  
  The unique identifier of the AppInstanceUserEndpoint.

UpdateAppInstanceUserEndpoint (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_app_instance_user_endpoint(
    AppInstanceUserArn='string',
    EndpointId='string',
    Name='string',
    AllowMessages='ALL'|'NONE'
)

type AppInstanceUserArn:

string

param AppInstanceUserArn:

[REQUIRED]

The ARN of the AppInstanceUser.

type EndpointId:

string

param EndpointId:

[REQUIRED]

The unique identifier of the AppInstanceUserEndpoint.

type Name:

string

param Name:

The name of the AppInstanceUserEndpoint.

type AllowMessages:

string

param AllowMessages:

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.

rtype:

dict

returns:

Response Syntax

{
    'AppInstanceUserArn': 'string',
    'EndpointId': 'string'
}

Response Structure

(dict) --
- AppInstanceUserArn (string) --
  
  The ARN of the AppInstanceUser.
- EndpointId (string) --
  
  The unique identifier of the AppInstanceUserEndpoint.