Amazon Connect Service

2022/10/13 - Amazon Connect Service - 3 updated api methods

Changes  This release adds support for a secondary email and a mobile number for Amazon Connect instance users.

CreateUser (updated) Link ¶
Changes (request) 
{'IdentityInfo': {'Mobile': 'string', 'SecondaryEmail': 'string'}}

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

client.create_user(
    Username='string',
    Password='string',
    IdentityInfo={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'SecondaryEmail': 'string',
        'Mobile': 'string'
    },
    PhoneConfig={
        'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
        'AutoAccept': True|False,
        'AfterContactWorkTimeLimit': 123,
        'DeskPhoneNumber': 'string'
    },
    DirectoryUserId='string',
    SecurityProfileIds=[
        'string',
    ],
    RoutingProfileId='string',
    HierarchyGroupId='string',
    InstanceId='string',
    Tags={
        'string': 'string'
    }
)
type Username:

string

param Username:

[REQUIRED]

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.

type Password:

string

param Password:

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

type IdentityInfo:

dict

param IdentityInfo:

The information about the identity of the user.

  • FirstName (string) --

    The first name. This is required if you are using Amazon Connect or SAML for identity management.

  • LastName (string) --

    The last name. This is required if you are using Amazon Connect or SAML for identity management.

  • Email (string) --

    The email address. If you are using SAML for identity management and include this parameter, an error is returned.

  • SecondaryEmail (string) --

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

  • Mobile (string) --

    The user's mobile number.

type PhoneConfig:

dict

param PhoneConfig:

[REQUIRED]

The phone settings for the user.

  • PhoneType (string) -- [REQUIRED]

    The phone type.

  • AutoAccept (boolean) --

    The Auto accept setting.

  • AfterContactWorkTimeLimit (integer) --

    The After Call Work (ACW) timeout setting, in seconds.

  • DeskPhoneNumber (string) --

    The phone number for the user's desk phone.

type DirectoryUserId:

string

param DirectoryUserId:

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

type SecurityProfileIds:

list

param SecurityProfileIds:

[REQUIRED]

The identifier of the security profile for the user.

  • (string) --

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile for the user.

type HierarchyGroupId:

string

param HierarchyGroupId:

The identifier of the hierarchy group for the user.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'UserId': 'string',
    'UserArn': 'string'
}

Response Structure

  • (dict) --

    • UserId (string) --

      The identifier of the user account.

    • UserArn (string) --

      The Amazon Resource Name (ARN) of the user account.

DescribeUser (updated) Link ¶
Changes (response) 
{'User': {'IdentityInfo': {'Mobile': 'string', 'SecondaryEmail': 'string'}}}

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

See also: AWS API Documentation

Request Syntax

client.describe_user(
    UserId='string',
    InstanceId='string'
)
type UserId:

string

param UserId:

[REQUIRED]

The identifier of the user account.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'Id': 'string',
        'Arn': 'string',
        'Username': 'string',
        'IdentityInfo': {
            'FirstName': 'string',
            'LastName': 'string',
            'Email': 'string',
            'SecondaryEmail': 'string',
            'Mobile': 'string'
        },
        'PhoneConfig': {
            'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
            'AutoAccept': True|False,
            'AfterContactWorkTimeLimit': 123,
            'DeskPhoneNumber': 'string'
        },
        'DirectoryUserId': 'string',
        'SecurityProfileIds': [
            'string',
        ],
        'RoutingProfileId': 'string',
        'HierarchyGroupId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • User (dict) --

      Information about the user account and configuration settings.

      • Id (string) --

        The identifier of the user account.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the user account.

      • Username (string) --

        The user name assigned to the user account.

      • IdentityInfo (dict) --

        Information about the user identity.

        • FirstName (string) --

          The first name. This is required if you are using Amazon Connect or SAML for identity management.

        • LastName (string) --

          The last name. This is required if you are using Amazon Connect or SAML for identity management.

        • Email (string) --

          The email address. If you are using SAML for identity management and include this parameter, an error is returned.

        • SecondaryEmail (string) --

          The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

        • Mobile (string) --

          The user's mobile number.

      • PhoneConfig (dict) --

        Information about the phone configuration for the user.

        • PhoneType (string) --

          The phone type.

        • AutoAccept (boolean) --

          The Auto accept setting.

        • AfterContactWorkTimeLimit (integer) --

          The After Call Work (ACW) timeout setting, in seconds.

        • DeskPhoneNumber (string) --

          The phone number for the user's desk phone.

      • DirectoryUserId (string) --

        The identifier of the user account in the directory used for identity management.

      • SecurityProfileIds (list) --

        The identifiers of the security profiles for the user.

        • (string) --

      • RoutingProfileId (string) --

        The identifier of the routing profile for the user.

      • HierarchyGroupId (string) --

        The identifier of the hierarchy group for the user.

      • Tags (dict) --

        The tags.

        • (string) --

          • (string) --

UpdateUserIdentityInfo (updated) Link ¶
Changes (request) 
{'IdentityInfo': {'Mobile': 'string', 'SecondaryEmail': 'string'}}

Updates the identity information for the specified user.

See also: AWS API Documentation

Request Syntax

client.update_user_identity_info(
    IdentityInfo={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'SecondaryEmail': 'string',
        'Mobile': 'string'
    },
    UserId='string',
    InstanceId='string'
)
type IdentityInfo:

dict

param IdentityInfo:

[REQUIRED]

The identity information for the user.

  • FirstName (string) --

    The first name. This is required if you are using Amazon Connect or SAML for identity management.

  • LastName (string) --

    The last name. This is required if you are using Amazon Connect or SAML for identity management.

  • Email (string) --

    The email address. If you are using SAML for identity management and include this parameter, an error is returned.

  • SecondaryEmail (string) --

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

  • Mobile (string) --

    The user's mobile number.

type UserId:

string

param UserId:

[REQUIRED]

The identifier of the user account.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

returns:

None