AWS API Changes

2023/03/23 - Amazon Chime SDK Identity - 6 new 2 updated api methods

Changes AppInstanceBots can be used to add a bot powered by Amazon Lex to chat channels. ExpirationSettings provides automatic resource deletion for AppInstanceUsers.

ListAppInstanceBots (new)

Link ¶

Lists all AppInstanceBots created under a single AppInstance .

See also: AWS API Documentation

Request Syntax

client.list_app_instance_bots(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)

type AppInstanceArn

string

param AppInstanceArn

[REQUIRED]

The ARN of the AppInstance .

type MaxResults

integer

param MaxResults

The maximum number of requests to return.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceBots': [
        {
            'AppInstanceBotArn': 'string',
            'Name': 'string',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AppInstanceArn (string) --
  
  The ARN of the AppInstance.
- AppInstanceBots (list) --
  
  The information for each requested AppInstanceBot .
  - (dict) --
    
    High-level information about an AppInstanceBot.
    - AppInstanceBotArn (string) --
      
      The ARN of the AppInstanceBot.
    - Name (string) --
      
      The name of the AppInstanceBox.
    - Metadata (string) --
      
      The metadata of the AppInstanceBot.
- NextToken (string) --
  
  The token passed by previous API calls until all requested bots are returned.

PutAppInstanceUserExpirationSettings (new)

Link ¶

Sets the number of days before the AppInstanceUser is automatically deleted.

Note

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.

See also: AWS API Documentation

Request Syntax

client.put_app_instance_user_expiration_settings(
    AppInstanceUserArn='string',
    ExpirationSettings={
        'ExpirationDays': 123,
        'ExpirationCriterion': 'CREATED_TIMESTAMP'
    }
)

type AppInstanceUserArn

string

param AppInstanceUserArn

[REQUIRED]

The ARN of the AppInstanceUser .

type ExpirationSettings

dict

param ExpirationSettings

Settings that control the interval after which an AppInstanceUser is automatically deleted.

ExpirationDays (integer) -- [REQUIRED]

The period in days after which an AppInstanceUser will be automatically deleted.
ExpirationCriterion (string) -- [REQUIRED]

Specifies the conditions under which an AppInstanceUser will expire.

rtype

dict

returns

Response Syntax

{
    'AppInstanceUserArn': 'string',
    'ExpirationSettings': {
        'ExpirationDays': 123,
        'ExpirationCriterion': 'CREATED_TIMESTAMP'
    }
}

Response Structure

(dict) --
- AppInstanceUserArn (string) --
  
  The ARN of the AppInstanceUser .
- ExpirationSettings (dict) --
  
  Settings that control the interval after which an AppInstanceUser is automatically deleted.
  - ExpirationDays (integer) --
    
    The period in days after which an AppInstanceUser will be automatically deleted.
  - ExpirationCriterion (string) --
    
    Specifies the conditions under which an AppInstanceUser will expire.

UpdateAppInstanceBot (new)

Link ¶

Updates the name and metadata of an AppInstanceBot .

See also: AWS API Documentation

Request Syntax

client.update_app_instance_bot(
    AppInstanceBotArn='string',
    Name='string',
    Metadata='string'
)

type AppInstanceBotArn

string

param AppInstanceBotArn

[REQUIRED]

The ARN of the AppInstanceBot .

type Name

string

param Name

[REQUIRED]

The name of the AppInstanceBot .

type Metadata

string

param Metadata

[REQUIRED]

The metadata of the AppInstanceBot .

rtype

dict

returns

Response Syntax

{
    'AppInstanceBotArn': 'string'
}

Response Structure

(dict) --
- AppInstanceBotArn (string) --
  
  The ARN of the AppInstanceBot .

CreateAppInstanceBot (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_app_instance_bot(
    AppInstanceArn='string',
    Name='string',
    Metadata='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Configuration={
        'Lex': {
            'RespondsTo': 'STANDARD_MESSAGES',
            'LexBotAliasArn': 'string',
            'LocaleId': 'string',
            'WelcomeIntent': 'string'
        }
    }
)

type AppInstanceArn

string

param AppInstanceArn

[REQUIRED]

The ARN of the AppInstance request.

type Name

string

param Name

The user's name.

type Metadata

string

param Metadata

The request metadata. Limited to a 1KB string in UTF-8.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

The unique ID for the client making the request. Use different tokens for different AppInstanceBots .

This field is autopopulated if not provided.

type Tags

list

param Tags

The tags assigned to the AppInstanceBot .

(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.

type Configuration

dict

param Configuration

[REQUIRED]

Configuration information about the Amazon Lex V2 V2 bot.

Lex (dict) -- [REQUIRED]

The configuration for an Amazon Lex V2 bot.
- RespondsTo (string) -- [REQUIRED]
  
  Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
- LexBotAliasArn (string) -- [REQUIRED]
  
  The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS
- LocaleId (string) -- [REQUIRED]
  
  Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide .
- WelcomeIntent (string) --
  
  The name of the welcome intent configured in the Amazon Lex V2 bot.

rtype

dict

returns

Response Syntax

{
    'AppInstanceBotArn': 'string'
}

Response Structure

(dict) --
- AppInstanceBotArn (string) --
  
  The ARN of the AppinstanceBot .

DeleteAppInstanceBot (new)

Link ¶

Deletes an AppInstanceBot .

See also: AWS API Documentation

Request Syntax

client.delete_app_instance_bot(
    AppInstanceBotArn='string'
)

type AppInstanceBotArn

string

param AppInstanceBotArn

[REQUIRED]

The ARN of the AppInstanceBot being deleted.

returns

None

DescribeAppInstanceBot (new)

Link ¶

The AppInstanceBot's information.

See also: AWS API Documentation

Request Syntax

client.describe_app_instance_bot(
    AppInstanceBotArn='string'
)

type AppInstanceBotArn

string

param AppInstanceBotArn

[REQUIRED]

The ARN of the AppInstanceBot .

rtype

dict

returns

Response Syntax

{
    'AppInstanceBot': {
        'AppInstanceBotArn': 'string',
        'Name': 'string',
        'Configuration': {
            'Lex': {
                'RespondsTo': 'STANDARD_MESSAGES',
                'LexBotAliasArn': 'string',
                'LocaleId': 'string',
                'WelcomeIntent': 'string'
            }
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Metadata': 'string'
    }
}

Response Structure

(dict) --
- AppInstanceBot (dict) --
  
  The detials of the AppInstanceBot .
  - AppInstanceBotArn (string) --
    
    The ARN of the AppInstanceBot.
  - Name (string) --
    
    The name of the AppInstanceBot.
  - Configuration (dict) --
    
    The data processing instructions for an AppInstanceBot.
    - Lex (dict) --
      
      The configuration for an Amazon Lex V2 bot.
      - RespondsTo (string) --
        
        Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
      - LexBotAliasArn (string) --
        
        The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS
      - LocaleId (string) --
        
        Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide .
      - WelcomeIntent (string) --
        
        The name of the welcome intent configured in the Amazon Lex V2 bot.
  - CreatedTimestamp (datetime) --
    
    The time at which the AppInstanceBot was created.
  - LastUpdatedTimestamp (datetime) --
    
    The time at which the AppInstanceBot was last updated.
  - Metadata (string) --
    
    The metadata for an AppInstanceBot.

CreateAppInstanceUser (updated)

Link ¶
Changes (request)

{'ExpirationSettings': {'ExpirationCriterion': 'CREATED_TIMESTAMP',
                        'ExpirationDays': 'integer'}}

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

See also: AWS API Documentation

Request Syntax

client.create_app_instance_user(
    AppInstanceArn='string',
    AppInstanceUserId='string',
    Name='string',
    Metadata='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ExpirationSettings={
        'ExpirationDays': 123,
        'ExpirationCriterion': 'CREATED_TIMESTAMP'
    }
)

type AppInstanceArn

string

param AppInstanceArn

[REQUIRED]

The ARN of the AppInstance request.

type AppInstanceUserId

string

param AppInstanceUserId

[REQUIRED]

The user ID of the AppInstance .

type Name

string

param Name

[REQUIRED]

The user's name.

type Metadata

string

param Metadata

The request's metadata. Limited to a 1KB string in UTF-8.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

The unique ID of the request. Use different tokens to request additional AppInstances .

This field is autopopulated if not provided.

type Tags

list

param Tags

Tags assigned to the AppInstanceUser .

(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.

type ExpirationSettings

dict

param ExpirationSettings

Settings that control the interval after which the AppInstanceUser is automatically deleted.

ExpirationDays (integer) -- [REQUIRED]

The period in days after which an AppInstanceUser will be automatically deleted.
ExpirationCriterion (string) -- [REQUIRED]

Specifies the conditions under which an AppInstanceUser will expire.

rtype

dict

returns

Response Syntax

{
    'AppInstanceUserArn': 'string'
}

Response Structure

(dict) --
- AppInstanceUserArn (string) --
  
  The user's ARN.

DescribeAppInstanceUser (updated)

Link ¶
Changes (response)

{'AppInstanceUser': {'ExpirationSettings': {'ExpirationCriterion': 'CREATED_TIMESTAMP',
                                            'ExpirationDays': 'integer'}}}

Returns the full details of an AppInstanceUser .

See also: AWS API Documentation

Request Syntax

client.describe_app_instance_user(
    AppInstanceUserArn='string'
)

type AppInstanceUserArn

string

param AppInstanceUserArn

[REQUIRED]

The ARN of the AppInstanceUser .

rtype

dict

returns

Response Syntax

{
    'AppInstanceUser': {
        'AppInstanceUserArn': 'string',
        'Name': 'string',
        'Metadata': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'ExpirationSettings': {
            'ExpirationDays': 123,
            'ExpirationCriterion': 'CREATED_TIMESTAMP'
        }
    }
}

Response Structure

(dict) --
- AppInstanceUser (dict) --
  
  The name of the AppInstanceUser .
  - AppInstanceUserArn (string) --
    
    The ARN of the AppInstanceUser .
  - Name (string) --
    
    The name of the AppInstanceUser .
  - Metadata (string) --
    
    The metadata of the AppInstanceUser .
  - CreatedTimestamp (datetime) --
    
    The time at which the AppInstanceUser was created.
  - LastUpdatedTimestamp (datetime) --
    
    The time at which the AppInstanceUser was last updated.
  - ExpirationSettings (dict) --
    
    The interval after which an AppInstanceUser is automatically deleted.
    - ExpirationDays (integer) --
      
      The period in days after which an AppInstanceUser will be automatically deleted.
    - ExpirationCriterion (string) --
      
      Specifies the conditions under which an AppInstanceUser will expire.