Amazon Connect Service 2017-08-08

AssociateApprovedOrigin

$result = $client->associateApprovedOrigin([/* ... */]);
$promise = $client->associateApprovedOriginAsync([/* ... */]);

Parameter Syntax

$result = $client->associateApprovedOrigin([
    'InstanceId' => '<string>', // REQUIRED
    'Origin' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceConflictException:

  A resource already has that name.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ServiceQuotaExceededException:

  The service quota has been exceeded.

• ThrottlingException:

  The throttling limit has been exceeded.

AssociateInstanceStorageConfig

$result = $client->associateInstanceStorageConfig([/* ... */]);
$promise = $client->associateInstanceStorageConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->associateInstanceStorageConfig([
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
    'StorageConfig' => [ // REQUIRED
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>', // REQUIRED
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>', // REQUIRED
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [ // REQUIRED
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
            'Prefix' => '<string>', // REQUIRED
            'RetentionPeriodHours' => <integer>, // REQUIRED
        ],
        'S3Config' => [
            'BucketName' => '<string>', // REQUIRED
            'BucketPrefix' => '<string>', // REQUIRED
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'AssociationId' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceConflictException:

  A resource already has that name.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

AssociateLambdaFunction

$result = $client->associateLambdaFunction([/* ... */]);
$promise = $client->associateLambdaFunctionAsync([/* ... */]);

Parameter Syntax

$result = $client->associateLambdaFunction([
    'FunctionArn' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceConflictException:

  A resource already has that name.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ServiceQuotaExceededException:

  The service quota has been exceeded.

• ThrottlingException:

  The throttling limit has been exceeded.

AssociateLexBot

$result = $client->associateLexBot([/* ... */]);
$promise = $client->associateLexBotAsync([/* ... */]);

Parameter Syntax

$result = $client->associateLexBot([
    'InstanceId' => '<string>', // REQUIRED
    'LexBot' => [ // REQUIRED
        'LexRegion' => '<string>',
        'Name' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceConflictException:

  A resource already has that name.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ServiceQuotaExceededException:

  The service quota has been exceeded.

• ThrottlingException:

  The throttling limit has been exceeded.

AssociateRoutingProfileQueues

$result = $client->associateRoutingProfileQueues([/* ... */]);
$promise = $client->associateRoutingProfileQueuesAsync([/* ... */]);

Parameter Syntax

$result = $client->associateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueConfigs' => [ // REQUIRED
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

AssociateSecurityKey

$result = $client->associateSecurityKey([/* ... */]);
$promise = $client->associateSecurityKeyAsync([/* ... */]);

Parameter Syntax

$result = $client->associateSecurityKey([
    'InstanceId' => '<string>', // REQUIRED
    'Key' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AssociationId' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceConflictException:

  A resource already has that name.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ServiceQuotaExceededException:

  The service quota has been exceeded.

• ThrottlingException:

  The throttling limit has been exceeded.

CreateContactFlow

$result = $client->createContactFlow([/* ... */]);
$promise = $client->createContactFlowAsync([/* ... */]);

Parameter Syntax

$result = $client->createContactFlow([
    'Content' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactFlowArn' => '<string>',
    'ContactFlowId' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidContactFlowException:

  The contact flow is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• DuplicateResourceException:

  A resource with the specified name already exists.

• LimitExceededException:

  The allowed limit for the resource has been exceeded.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

CreateInstance

$result = $client->createInstance([/* ... */]);
$promise = $client->createInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->createInstance([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>',
    'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY', // REQUIRED
    'InboundCallsEnabled' => true || false, // REQUIRED
    'InstanceAlias' => '<string>',
    'OutboundCallsEnabled' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• ServiceQuotaExceededException:

  The service quota has been exceeded.

• ThrottlingException:

  The throttling limit has been exceeded.

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

CreateRoutingProfile

$result = $client->createRoutingProfile([/* ... */]);
$promise = $client->createRoutingProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->createRoutingProfile([
    'DefaultOutboundQueueId' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'MediaConcurrencies' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT', // REQUIRED
            'Concurrency' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'QueueConfigs' => [
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'RoutingProfileArn' => '<string>',
    'RoutingProfileId' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• DuplicateResourceException:

  A resource with the specified name already exists.

• ResourceNotFoundException:

  The specified resource was not found.

• LimitExceededException:

  The allowed limit for the resource has been exceeded.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Parameter Syntax

$result = $client->createUser([
    'DirectoryUserId' => '<string>',
    'HierarchyGroupId' => '<string>',
    'IdentityInfo' => [
        'Email' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'PhoneConfig' => [ // REQUIRED
        'AfterContactWorkTimeLimit' => <integer>,
        'AutoAccept' => true || false,
        'DeskPhoneNumber' => '<string>',
        'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
    'SecurityProfileIds' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• LimitExceededException:

  The allowed limit for the resource has been exceeded.

• DuplicateResourceException:

  A resource with the specified name already exists.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

CreateUserHierarchyGroup

$result = $client->createUserHierarchyGroup([/* ... */]);
$promise = $client->createUserHierarchyGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createUserHierarchyGroup([
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ParentGroupId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'HierarchyGroupArn' => '<string>',
    'HierarchyGroupId' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• DuplicateResourceException:

  A resource with the specified name already exists.

• LimitExceededException:

  The allowed limit for the resource has been exceeded.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DeleteInstance

$result = $client->deleteInstance([/* ... */]);
$promise = $client->deleteInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteInstance([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DeleteUserHierarchyGroup

$result = $client->deleteUserHierarchyGroup([/* ... */]);
$promise = $client->deleteUserHierarchyGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceInUseException:

  That resource is already in use. Please try another.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DescribeContactFlow

$result = $client->describeContactFlow([/* ... */]);
$promise = $client->describeContactFlowAsync([/* ... */]);

Parameter Syntax

$result = $client->describeContactFlow([
    'ContactFlowId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactFlow' => [
        'Arn' => '<string>',
        'Content' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Tags' => ['<string>', ...],
        'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER',
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ContactFlowNotPublishedException:

  The contact flow has not been published.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DescribeInstance

$result = $client->describeInstance([/* ... */]);
$promise = $client->describeInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->describeInstance([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Instance' => [
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY',
        'InboundCallsEnabled' => true || false,
        'InstanceAlias' => '<string>',
        'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED',
        'OutboundCallsEnabled' => true || false,
        'ServiceRole' => '<string>',
        'StatusReason' => [
            'Message' => '<string>',
        ],
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DescribeInstanceAttribute

$result = $client->describeInstanceAttribute([/* ... */]);
$promise = $client->describeInstanceAttributeAsync([/* ... */]);

Parameter Syntax

$result = $client->describeInstanceAttribute([
    'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attribute' => [
        'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA',
        'Value' => '<string>',
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

DescribeInstanceStorageConfig

$result = $client->describeInstanceStorageConfig([/* ... */]);
$promise = $client->describeInstanceStorageConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->describeInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'StorageConfig' => [
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>',
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>',
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS',
                'KeyId' => '<string>',
            ],
            'Prefix' => '<string>',
            'RetentionPeriodHours' => <integer>,
        ],
        'S3Config' => [
            'BucketName' => '<string>',
            'BucketPrefix' => '<string>',
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS',
                'KeyId' => '<string>',
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE',
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

DescribeRoutingProfile

$result = $client->describeRoutingProfile([/* ... */]);
$promise = $client->describeRoutingProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->describeRoutingProfile([
    'InstanceId' => '<string>', // REQUIRED
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RoutingProfile' => [
        'DefaultOutboundQueueId' => '<string>',
        'Description' => '<string>',
        'InstanceId' => '<string>',
        'MediaConcurrencies' => [
            [
                'Channel' => 'VOICE|CHAT',
                'Concurrency' => <integer>,
            ],
            // ...
        ],
        'Name' => '<string>',
        'RoutingProfileArn' => '<string>',
        'RoutingProfileId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Parameter Syntax

$result = $client->describeUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'Arn' => '<string>',
        'DirectoryUserId' => '<string>',
        'HierarchyGroupId' => '<string>',
        'Id' => '<string>',
        'IdentityInfo' => [
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
        ],
        'PhoneConfig' => [
            'AfterContactWorkTimeLimit' => <integer>,
            'AutoAccept' => true || false,
            'DeskPhoneNumber' => '<string>',
            'PhoneType' => 'SOFT_PHONE|DESK_PHONE',
        ],
        'RoutingProfileId' => '<string>',
        'SecurityProfileIds' => ['<string>', ...],
        'Tags' => ['<string>', ...],
        'Username' => '<string>',
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DescribeUserHierarchyGroup

$result = $client->describeUserHierarchyGroup([/* ... */]);
$promise = $client->describeUserHierarchyGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->describeUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HierarchyGroup' => [
        'Arn' => '<string>',
        'HierarchyPath' => [
            'LevelFive' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelFour' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelOne' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelThree' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelTwo' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'LevelId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DescribeUserHierarchyStructure

$result = $client->describeUserHierarchyStructure([/* ... */]);
$promise = $client->describeUserHierarchyStructureAsync([/* ... */]);

Parameter Syntax

$result = $client->describeUserHierarchyStructure([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HierarchyStructure' => [
        'LevelFive' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelFour' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelOne' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelThree' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelTwo' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DisassociateApprovedOrigin

$result = $client->disassociateApprovedOrigin([/* ... */]);
$promise = $client->disassociateApprovedOriginAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateApprovedOrigin([
    'InstanceId' => '<string>', // REQUIRED
    'Origin' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

DisassociateInstanceStorageConfig

$result = $client->disassociateInstanceStorageConfig([/* ... */]);
$promise = $client->disassociateInstanceStorageConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

DisassociateLambdaFunction

$result = $client->disassociateLambdaFunction([/* ... */]);
$promise = $client->disassociateLambdaFunctionAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateLambdaFunction([
    'FunctionArn' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

DisassociateLexBot

$result = $client->disassociateLexBot([/* ... */]);
$promise = $client->disassociateLexBotAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateLexBot([
    'BotName' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'LexRegion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

DisassociateRoutingProfileQueues

$result = $client->disassociateRoutingProfileQueues([/* ... */]);
$promise = $client->disassociateRoutingProfileQueuesAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueReferences' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT', // REQUIRED
            'QueueId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

DisassociateSecurityKey

$result = $client->disassociateSecurityKey([/* ... */]);
$promise = $client->disassociateSecurityKeyAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateSecurityKey([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

GetContactAttributes

$result = $client->getContactAttributes([/* ... */]);
$promise = $client->getContactAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->getContactAttributes([
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => ['<string>', ...],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

GetCurrentMetricData

$result = $client->getCurrentMetricData([/* ... */]);
$promise = $client->getCurrentMetricDataAsync([/* ... */]);

Parameter Syntax

$result = $client->getCurrentMetricData([
    'CurrentMetrics' => [ // REQUIRED
        [
            'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataSnapshotTime' => <DateTime>,
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE|CHAT',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• ThrottlingException:

  The throttling limit has been exceeded.

• ResourceNotFoundException:

  The specified resource was not found.

GetFederationToken

$result = $client->getFederationToken([/* ... */]);
$promise = $client->getFederationTokenAsync([/* ... */]);

Parameter Syntax

$result = $client->getFederationToken([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Credentials' => [
        'AccessToken' => '<string>',
        'AccessTokenExpiration' => <DateTime>,
        'RefreshToken' => '<string>',
        'RefreshTokenExpiration' => <DateTime>,
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• UserNotFoundException:

  No user with the specified credentials was found in the Amazon Connect instance.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• DuplicateResourceException:

  A resource with the specified name already exists.

GetMetricData

$result = $client->getMetricData([/* ... */]);
$promise = $client->getMetricDataAsync([/* ... */]);

Parameter Syntax

$result = $client->getMetricData([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'HistoricalMetrics' => [ // REQUIRED
        [
            'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
            'Statistic' => 'SUM|MAX|AVG',
            'Threshold' => [
                'Comparison' => 'LT',
                'ThresholdValue' => <float>,
            ],
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
                        'Statistic' => 'SUM|MAX|AVG',
                        'Threshold' => [
                            'Comparison' => 'LT',
                            'ThresholdValue' => <float>,
                        ],
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE|CHAT',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• ThrottlingException:

  The throttling limit has been exceeded.

• ResourceNotFoundException:

  The specified resource was not found.

ListApprovedOrigins

$result = $client->listApprovedOrigins([/* ... */]);
$promise = $client->listApprovedOriginsAsync([/* ... */]);

Parameter Syntax

$result = $client->listApprovedOrigins([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Origins' => ['<string>', ...],
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

ListContactFlows

$result = $client->listContactFlows([/* ... */]);
$promise = $client->listContactFlowsAsync([/* ... */]);

Parameter Syntax

$result = $client->listContactFlows([
    'ContactFlowTypes' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContactFlowSummaryList' => [
        [
            'Arn' => '<string>',
            'ContactFlowType' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

ListHoursOfOperations

$result = $client->listHoursOfOperations([/* ... */]);
$promise = $client->listHoursOfOperationsAsync([/* ... */]);

Parameter Syntax

$result = $client->listHoursOfOperations([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'HoursOfOperationSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

ListInstanceAttributes

$result = $client->listInstanceAttributes([/* ... */]);
$promise = $client->listInstanceAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->listInstanceAttributes([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        [
            'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

ListInstanceStorageConfigs

$result = $client->listInstanceStorageConfigs([/* ... */]);
$promise = $client->listInstanceStorageConfigsAsync([/* ... */]);

Parameter Syntax

$result = $client->listInstanceStorageConfigs([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'StorageConfigs' => [
        [
            'AssociationId' => '<string>',
            'KinesisFirehoseConfig' => [
                'FirehoseArn' => '<string>',
            ],
            'KinesisStreamConfig' => [
                'StreamArn' => '<string>',
            ],
            'KinesisVideoStreamConfig' => [
                'EncryptionConfig' => [
                    'EncryptionType' => 'KMS',
                    'KeyId' => '<string>',
                ],
                'Prefix' => '<string>',
                'RetentionPeriodHours' => <integer>,
            ],
            'S3Config' => [
                'BucketName' => '<string>',
                'BucketPrefix' => '<string>',
                'EncryptionConfig' => [
                    'EncryptionType' => 'KMS',
                    'KeyId' => '<string>',
                ],
            ],
            'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

ListInstances

$result = $client->listInstances([/* ... */]);
$promise = $client->listInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->listInstances([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'InstanceSummaryList' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Id' => '<string>',
            'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY',
            'InboundCallsEnabled' => true || false,
            'InstanceAlias' => '<string>',
            'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED',
            'OutboundCallsEnabled' => true || false,
            'ServiceRole' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

ListLambdaFunctions

$result = $client->listLambdaFunctions([/* ... */]);
$promise = $client->listLambdaFunctionsAsync([/* ... */]);

Parameter Syntax

$result = $client->listLambdaFunctions([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LambdaFunctions' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

ListLexBots

$result = $client->listLexBots([/* ... */]);
$promise = $client->listLexBotsAsync([/* ... */]);

Parameter Syntax

$result = $client->listLexBots([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LexBots' => [
        [
            'LexRegion' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ThrottlingException:

  The throttling limit has been exceeded.

ListPhoneNumbers

$result = $client->listPhoneNumbers([/* ... */]);
$promise = $client->listPhoneNumbersAsync([/* ... */]);

Parameter Syntax

$result = $client->listPhoneNumbers([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberCountryCodes' => ['<string>', ...],
    'PhoneNumberTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumberSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'PhoneNumber' => '<string>',
            'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW',
            'PhoneNumberType' => 'TOLL_FREE|DID',
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

ListPrompts

$result = $client->listPrompts([/* ... */]);
$promise = $client->listPromptsAsync([/* ... */]);

Parameter Syntax

$result = $client->listPrompts([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PromptSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

ListQueues

$result = $client->listQueues([/* ... */]);
$promise = $client->listQueuesAsync([/* ... */]);

Parameter Syntax

$result = $client->listQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueueTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'QueueSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'QueueType' => 'STANDARD|AGENT',
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidRequestException:

  The request is not valid.

• InvalidParameterException:

  One or more of the specified parameters are not valid.

• ResourceNotFoundException:

  The specified resource was not found.

• ThrottlingException:

  The throttling limit has been exceeded.

• InternalServiceException:

  Request processing failed due to an error or failure with the service.

ListRoutingProfileQueues

$result = $client->listRoutingProfileQueues([/* ... */]);
$promise = $client->listRoutingProfileQueuesAsync([/* ... */]);

Parameter Syntax

$result = $client->listRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details