AWS API Changes

2020/04/06 - Amazon Chime - 8 new api methods

Changes Update chime client to latest version

CreateProxySession (new)

Link ¶

Request Syntax

client.create_proxy_session(
    VoiceConnectorId='string',
    ParticipantPhoneNumbers=[
        'string',
    ],
    Name='string',
    ExpiryMinutes=123,
    Capabilities=[
        'Voice'|'SMS',
    ],
    NumberSelectionBehavior='PreferSticky'|'AvoidSticky',
    GeoMatchLevel='Country'|'AreaCode',
    GeoMatchParams={
        'Country': 'string',
        'AreaCode': 'string'
    }
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

type ParticipantPhoneNumbers:

list

param ParticipantPhoneNumbers:

[REQUIRED]

(string) --

type Name:

string

param Name:

type ExpiryMinutes:

integer

param ExpiryMinutes:

type Capabilities:

list

param Capabilities:

[REQUIRED]

(string) --

type NumberSelectionBehavior:

string

param NumberSelectionBehavior:

type GeoMatchLevel:

string

param GeoMatchLevel:

type GeoMatchParams:

dict

param GeoMatchParams:

Country (string) -- [REQUIRED]
AreaCode (string) -- [REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

(dict) --
- ProxySession (dict) --
  - VoiceConnectorId (string) --
  - ProxySessionId (string) --
  - Name (string) --
  - Status (string) --
  - ExpiryMinutes (integer) --
  - Capabilities (list) --
    - (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - EndedTimestamp (datetime) --
  - Participants (list) --
    - (dict) --
      - PhoneNumber (string) --
      - ProxyPhoneNumber (string) --
  - NumberSelectionBehavior (string) --
  - GeoMatchLevel (string) --
  - GeoMatchParams (dict) --
    - Country (string) --
    - AreaCode (string) --

ListProxySessions (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_proxy_sessions(
    VoiceConnectorId='string',
    Status='Open'|'InProgress'|'Closed',
    NextToken='string',
    MaxResults=123
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

type Status:

string

param Status:

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'ProxySessions': [
        {
            'VoiceConnectorId': 'string',
            'ProxySessionId': 'string',
            'Name': 'string',
            'Status': 'Open'|'InProgress'|'Closed',
            'ExpiryMinutes': 123,
            'Capabilities': [
                'Voice'|'SMS',
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'EndedTimestamp': datetime(2015, 1, 1),
            'Participants': [
                {
                    'PhoneNumber': 'string',
                    'ProxyPhoneNumber': 'string'
                },
            ],
            'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
            'GeoMatchLevel': 'Country'|'AreaCode',
            'GeoMatchParams': {
                'Country': 'string',
                'AreaCode': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ProxySessions (list) --
  - (dict) --
    - VoiceConnectorId (string) --
    - ProxySessionId (string) --
    - Name (string) --
    - Status (string) --
    - ExpiryMinutes (integer) --
    - Capabilities (list) --
      - (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
    - EndedTimestamp (datetime) --
    - Participants (list) --
      - (dict) --
        
        PhoneNumber (string) --
        
        ProxyPhoneNumber (string) --
    - NumberSelectionBehavior (string) --
    - GeoMatchLevel (string) --
    - GeoMatchParams (dict) --
      - Country (string) --
      - AreaCode (string) --
- NextToken (string) --

DeleteVoiceConnectorProxy (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_proxy(
    VoiceConnectorId='string'
)

type VoiceConnectorId:: string
param VoiceConnectorId:: [REQUIRED]
returns:: None

DeleteProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)

type VoiceConnectorId:: string
param VoiceConnectorId:: [REQUIRED]
type ProxySessionId:: string
param ProxySessionId:: [REQUIRED]
returns:: None

PutVoiceConnectorProxy (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_proxy(
    VoiceConnectorId='string',
    DefaultSessionExpiryMinutes=123,
    PhoneNumberPoolCountries=[
        'string',
    ],
    FallBackPhoneNumber='string',
    Disabled=True|False
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

type DefaultSessionExpiryMinutes:

integer

param DefaultSessionExpiryMinutes:

[REQUIRED]

type PhoneNumberPoolCountries:

list

param PhoneNumberPoolCountries:

[REQUIRED]

(string) --

type FallBackPhoneNumber:

string

param FallBackPhoneNumber:

type Disabled:

boolean

param Disabled:

rtype:

dict

returns:

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- Proxy (dict) --
  - DefaultSessionExpiryMinutes (integer) --
  - Disabled (boolean) --
  - FallBackPhoneNumber (string) --
  - PhoneNumberCountries (list) --
    - (string) --

GetVoiceConnectorProxy (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_proxy(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- Proxy (dict) --
  - DefaultSessionExpiryMinutes (integer) --
  - Disabled (boolean) --
  - FallBackPhoneNumber (string) --
  - PhoneNumberCountries (list) --
    - (string) --

GetProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

type ProxySessionId:

string

param ProxySessionId:

[REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

(dict) --
- ProxySession (dict) --
  - VoiceConnectorId (string) --
  - ProxySessionId (string) --
  - Name (string) --
  - Status (string) --
  - ExpiryMinutes (integer) --
  - Capabilities (list) --
    - (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - EndedTimestamp (datetime) --
  - Participants (list) --
    - (dict) --
      - PhoneNumber (string) --
      - ProxyPhoneNumber (string) --
  - NumberSelectionBehavior (string) --
  - GeoMatchLevel (string) --
  - GeoMatchParams (dict) --
    - Country (string) --
    - AreaCode (string) --

UpdateProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string',
    Capabilities=[
        'Voice'|'SMS',
    ],
    ExpiryMinutes=123
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

type ProxySessionId:

string

param ProxySessionId:

[REQUIRED]

type Capabilities:

list

param Capabilities:

[REQUIRED]

(string) --

type ExpiryMinutes:

integer

param ExpiryMinutes:

rtype:

dict

returns:

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

(dict) --
- ProxySession (dict) --
  - VoiceConnectorId (string) --
  - ProxySessionId (string) --
  - Name (string) --
  - Status (string) --
  - ExpiryMinutes (integer) --
  - Capabilities (list) --
    - (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - EndedTimestamp (datetime) --
  - Participants (list) --
    - (dict) --
      - PhoneNumber (string) --
      - ProxyPhoneNumber (string) --
  - NumberSelectionBehavior (string) --
  - GeoMatchLevel (string) --
  - GeoMatchParams (dict) --
    - Country (string) --
    - AreaCode (string) --