AssociateChannelFlow

$result = $client->associateChannelFlow([/* ... */]);
$promise = $client->associateChannelFlowAsync([/* ... */]);

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

Parameter Syntax

$result = $client->associateChannelFlow([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelFlowArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchCreateChannelMembership

$result = $client->batchCreateChannelMembership([/* ... */]);
$promise = $client->batchCreateChannelMembershipAsync([/* ... */]);

Adds a specified number of users and bots to a channel.

Parameter Syntax

$result = $client->batchCreateChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArns' => ['<string>', ...], // REQUIRED
    'SubChannelId' => '<string>',
    'Type' => 'DEFAULT|HIDDEN',
]);

Parameter Details

Result Syntax

[
    'BatchChannelMemberships' => [
        'ChannelArn' => '<string>',
        'InvitedBy' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'Members' => [
            [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
            // ...
        ],
        'SubChannelId' => '<string>',
        'Type' => 'DEFAULT|HIDDEN',
    ],
    'Errors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'MemberArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceFailureException:

The service encountered an unexpected error.

ServiceUnavailableException:

The service is currently unavailable.

UnauthorizedClientException:

The client is not currently authorized to make the request.

BadRequestException:

The input parameters don't match the service's restrictions.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ChannelFlowCallback

$result = $client->channelFlowCallback([/* ... */]);
$promise = $client->channelFlowCallbackAsync([/* ... */]);

Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

You can return one of the following processing responses:

• Update message content or metadata

• Deny a message

• Make no changes to the message

Parameter Syntax

$result = $client->channelFlowCallback([
    'CallbackId' => '<string>', // REQUIRED
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelMessage' => [ // REQUIRED
        'Content' => '<string>',
        'ContentType' => '<string>',
        'MessageAttributes' => [
            '<MessageAttributeName>' => [
                'StringValues' => ['<string>', ...],
            ],
            // ...
        ],
        'MessageId' => '<string>', // REQUIRED
        'Metadata' => '<string>',
        'PushNotification' => [
            'Body' => '<string>',
            'Title' => '<string>',
            'Type' => 'DEFAULT|VOIP',
        ],
        'SubChannelId' => '<string>',
    ],
    'DeleteResource' => true || false,
]);

Parameter Details

Result Syntax

[
    'CallbackId' => '<string>',
    'ChannelArn' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

Parameter Syntax

$result = $client->createChannel([
    'AppInstanceArn' => '<string>', // REQUIRED
    'ChannelId' => '<string>',
    'ChimeBearer' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'ElasticChannelConfiguration' => [
        'MaximumSubChannels' => <integer>, // REQUIRED
        'MinimumMembershipPercentage' => <integer>, // REQUIRED
        'TargetMembershipsPerSubChannel' => <integer>, // REQUIRED
    ],
    'ExpirationSettings' => [
        'ExpirationCriterion' => 'CREATED_TIMESTAMP|LAST_MESSAGE_TIMESTAMP', // REQUIRED
        'ExpirationDays' => <integer>, // REQUIRED
    ],
    'MemberArns' => ['<string>', ...],
    'Metadata' => '<string>',
    'Mode' => 'UNRESTRICTED|RESTRICTED',
    'ModeratorArns' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Privacy' => 'PUBLIC|PRIVATE',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateChannelBan

$result = $client->createChannelBan([/* ... */]);
$promise = $client->createChannelBanAsync([/* ... */]);

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

Parameter Syntax

$result = $client->createChannelBan([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Member' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateChannelFlow

$result = $client->createChannelFlow([/* ... */]);
$promise = $client->createChannelFlowAsync([/* ... */]);

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

Channel flows process the following items:

1. New and updated messages

2. Persistent and non-persistent messages

3. The Standard message type

Parameter Syntax

$result = $client->createChannelFlow([
    'AppInstanceArn' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Processors' => [ // REQUIRED
        [
            'Configuration' => [ // REQUIRED
                'Lambda' => [ // REQUIRED
                    'InvocationType' => 'ASYNC', // REQUIRED
                    'ResourceArn' => '<string>', // REQUIRED
                ],
            ],
            'ExecutionOrder' => <integer>, // REQUIRED
            'FallbackAction' => 'CONTINUE|ABORT', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateChannelMembership

$result = $client->createChannelMembership([/* ... */]);
$promise = $client->createChannelMembershipAsync([/* ... */]);

Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

• List messages

• Send messages

• Receive messages

• Edit their own messages

• Leave the channel

Privacy settings impact this action as follows:

• Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

• Private Channels: You must be a member to list or send messages.

Parameter Syntax

$result = $client->createChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
    'Type' => 'DEFAULT|HIDDEN', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Member' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
    'SubChannelId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateChannelModerator

$result = $client->createChannelModerator([/* ... */]);
$promise = $client->createChannelModeratorAsync([/* ... */]);

Creates a new ChannelModerator. A channel moderator can:

• Add and remove other members of the channel.

• Add and remove other moderators of the channel.

• Add and remove user bans for the channel.

• Redact messages in the channel.

• List messages in the channel.

Parameter Syntax

$result = $client->createChannelModerator([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelModeratorArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ChannelModerator' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannel

$result = $client->deleteChannel([/* ... */]);
$promise = $client->deleteChannelAsync([/* ... */]);

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

Parameter Syntax

$result = $client->deleteChannel([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannelBan

$result = $client->deleteChannelBan([/* ... */]);
$promise = $client->deleteChannelBanAsync([/* ... */]);

Removes a member from a channel's ban list.

Parameter Syntax

$result = $client->deleteChannelBan([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannelFlow

$result = $client->deleteChannelFlow([/* ... */]);
$promise = $client->deleteChannelFlowAsync([/* ... */]);

Deletes a channel flow, an irreversible process. This is a developer API.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannelMembership

$result = $client->deleteChannelMembership([/* ... */]);
$promise = $client->deleteChannelMembershipAsync([/* ... */]);

Removes a member from a channel.

Parameter Syntax

$result = $client->deleteChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannelMessage

$result = $client->deleteChannelMessage([/* ... */]);
$promise = $client->deleteChannelMessageAsync([/* ... */]);

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

Parameter Syntax

$result = $client->deleteChannelMessage([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannelModerator

$result = $client->deleteChannelModerator([/* ... */]);
$promise = $client->deleteChannelModeratorAsync([/* ... */]);

Deletes a channel moderator.

Parameter Syntax

$result = $client->deleteChannelModerator([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelModeratorArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteMessagingStreamingConfigurations

$result = $client->deleteMessagingStreamingConfigurations([/* ... */]);
$promise = $client->deleteMessagingStreamingConfigurationsAsync([/* ... */]);

Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannel

$result = $client->describeChannel([/* ... */]);
$promise = $client->describeChannelAsync([/* ... */]);

Returns the full details of a channel in an Amazon Chime AppInstance.

Parameter Syntax

$result = $client->describeChannel([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Channel' => [
        'ChannelArn' => '<string>',
        'ChannelFlowArn' => '<string>',
        'CreatedBy' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'ElasticChannelConfiguration' => [
            'MaximumSubChannels' => <integer>,
            'MinimumMembershipPercentage' => <integer>,
            'TargetMembershipsPerSubChannel' => <integer>,
        ],
        'ExpirationSettings' => [
            'ExpirationCriterion' => 'CREATED_TIMESTAMP|LAST_MESSAGE_TIMESTAMP',
            'ExpirationDays' => <integer>,
        ],
        'LastMessageTimestamp' => <DateTime>,
        'LastUpdatedTimestamp' => <DateTime>,
        'Metadata' => '<string>',
        'Mode' => 'UNRESTRICTED|RESTRICTED',
        'Name' => '<string>',
        'Privacy' => 'PUBLIC|PRIVATE',
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannelBan

$result = $client->describeChannelBan([/* ... */]);
$promise = $client->describeChannelBanAsync([/* ... */]);

Returns the full details of a channel ban.

Parameter Syntax

$result = $client->describeChannelBan([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelBan' => [
        'ChannelArn' => '<string>',
        'CreatedBy' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'Member' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannelFlow

$result = $client->describeChannelFlow([/* ... */]);
$promise = $client->describeChannelFlowAsync([/* ... */]);

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelFlow' => [
        'ChannelFlowArn' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'LastUpdatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'Processors' => [
            [
                'Configuration' => [
                    'Lambda' => [
                        'InvocationType' => 'ASYNC',
                        'ResourceArn' => '<string>',
                    ],
                ],
                'ExecutionOrder' => <integer>,
                'FallbackAction' => 'CONTINUE|ABORT',
                'Name' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannelMembership

$result = $client->describeChannelMembership([/* ... */]);
$promise = $client->describeChannelMembershipAsync([/* ... */]);

Returns the full details of a user's channel membership.

Parameter Syntax

$result = $client->describeChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelMembership' => [
        'ChannelArn' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'InvitedBy' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'LastUpdatedTimestamp' => <DateTime>,
        'Member' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'SubChannelId' => '<string>',
        'Type' => 'DEFAULT|HIDDEN',
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannelMembershipForAppInstanceUser

$result = $client->describeChannelMembershipForAppInstanceUser([/* ... */]);
$promise = $client->describeChannelMembershipForAppInstanceUserAsync([/* ... */]);

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

Parameter Syntax

$result = $client->describeChannelMembershipForAppInstanceUser([
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelMembership' => [
        'AppInstanceUserMembershipSummary' => [
            'ReadMarkerTimestamp' => <DateTime>,
            'SubChannelId' => '<string>',
            'Type' => 'DEFAULT|HIDDEN',
        ],
        'ChannelSummary' => [
            'ChannelArn' => '<string>',
            'LastMessageTimestamp' => <DateTime>,
            'Metadata' => '<string>',
            'Mode' => 'UNRESTRICTED|RESTRICTED',
            'Name' => '<string>',
            'Privacy' => 'PUBLIC|PRIVATE',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannelModeratedByAppInstanceUser

$result = $client->describeChannelModeratedByAppInstanceUser([/* ... */]);
$promise = $client->describeChannelModeratedByAppInstanceUserAsync([/* ... */]);

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

Parameter Syntax

$result = $client->describeChannelModeratedByAppInstanceUser([
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Channel' => [
        'ChannelSummary' => [
            'ChannelArn' => '<string>',
            'LastMessageTimestamp' => <DateTime>,
            'Metadata' => '<string>',
            'Mode' => 'UNRESTRICTED|RESTRICTED',
            'Name' => '<string>',
            'Privacy' => 'PUBLIC|PRIVATE',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DescribeChannelModerator

$result = $client->describeChannelModerator([/* ... */]);
$promise = $client->describeChannelModeratorAsync([/* ... */]);

Returns the full details of a single ChannelModerator.

Parameter Syntax

$result = $client->describeChannelModerator([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelModeratorArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelModerator' => [
        'ChannelArn' => '<string>',
        'CreatedBy' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'Moderator' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DisassociateChannelFlow

$result = $client->disassociateChannelFlow([/* ... */]);
$promise = $client->disassociateChannelFlowAsync([/* ... */]);

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

Parameter Syntax

$result = $client->disassociateChannelFlow([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelFlowArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetChannelMembershipPreferences

$result = $client->getChannelMembershipPreferences([/* ... */]);
$promise = $client->getChannelMembershipPreferencesAsync([/* ... */]);

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.

Parameter Syntax

$result = $client->getChannelMembershipPreferences([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Member' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
    'Preferences' => [
        'PushNotifications' => [
            'AllowNotifications' => 'ALL|NONE|FILTERED',
            'FilterRule' => '<string>',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetChannelMessage

$result = $client->getChannelMessage([/* ... */]);
$promise = $client->getChannelMessageAsync([/* ... */]);

Gets the full details of a channel message.

Parameter Syntax

$result = $client->getChannelMessage([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelMessage' => [
        'ChannelArn' => '<string>',
        'Content' => '<string>',
        'ContentType' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'LastEditedTimestamp' => <DateTime>,
        'LastUpdatedTimestamp' => <DateTime>,
        'MessageAttributes' => [
            '<MessageAttributeName>' => [
                'StringValues' => ['<string>', ...],
            ],
            // ...
        ],
        'MessageId' => '<string>',
        'Metadata' => '<string>',
        'Persistence' => 'PERSISTENT|NON_PERSISTENT',
        'Redacted' => true || false,
        'Sender' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'Status' => [
            'Detail' => '<string>',
            'Value' => 'SENT|PENDING|FAILED|DENIED',
        ],
        'SubChannelId' => '<string>',
        'Target' => [
            [
                'MemberArn' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STANDARD|CONTROL',
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetChannelMessageStatus

$result = $client->getChannelMessageStatus([/* ... */]);
$promise = $client->getChannelMessageStatusAsync([/* ... */]);

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.

Messages can have any one of these statuses.

SENT

Message processed successfully

PENDING

Ongoing processing

FAILED

Processing failed

DENIED

Message denied by the processor

Parameter Syntax

$result = $client->getChannelMessageStatus([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Status' => [
        'Detail' => '<string>',
        'Value' => 'SENT|PENDING|FAILED|DENIED',
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetMessagingSessionEndpoint

$result = $client->getMessagingSessionEndpoint([/* ... */]);
$promise = $client->getMessagingSessionEndpointAsync([/* ... */]);

The details of the endpoint for the messaging session.

Parameter Syntax

$result = $client->getMessagingSessionEndpoint([
]);

Parameter Details

Result Syntax

[
    'Endpoint' => [
        'Url' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetMessagingStreamingConfigurations

$result = $client->getMessagingStreamingConfigurations([/* ... */]);
$promise = $client->getMessagingStreamingConfigurationsAsync([/* ... */]);

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'StreamingConfigurations' => [
        [
            'DataType' => 'Channel|ChannelMessage',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelBans

$result = $client->listChannelBans([/* ... */]);
$promise = $client->listChannelBansAsync([/* ... */]);

Lists all the users and bots banned from a particular channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ChannelBans' => [
        [
            'Member' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelFlows

$result = $client->listChannelFlows([/* ... */]);
$promise = $client->listChannelFlowsAsync([/* ... */]);

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelFlows' => [
        [
            'ChannelFlowArn' => '<string>',
            'Name' => '<string>',
            'Processors' => [
                [
                    'Configuration' => [
                        'Lambda' => [
                            'InvocationType' => 'ASYNC',
                            'ResourceArn' => '<string>',
                        ],
                    ],
                    'ExecutionOrder' => <integer>,
                    'FallbackAction' => 'CONTINUE|ABORT',
                    'Name' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelMemberships

$result = $client->listChannelMemberships([/* ... */]);
$promise = $client->listChannelMembershipsAsync([/* ... */]);

Lists all channel memberships in a channel.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

Parameter Syntax

$result = $client->listChannelMemberships([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubChannelId' => '<string>',
    'Type' => 'DEFAULT|HIDDEN',
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ChannelMemberships' => [
        [
            'Member' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelMembershipsForAppInstanceUser

$result = $client->listChannelMembershipsForAppInstanceUser([/* ... */]);
$promise = $client->listChannelMembershipsForAppInstanceUserAsync([/* ... */]);

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelMemberships' => [
        [
            'AppInstanceUserMembershipSummary' => [
                'ReadMarkerTimestamp' => <DateTime>,
                'SubChannelId' => '<string>',
                'Type' => 'DEFAULT|HIDDEN',
            ],
            'ChannelSummary' => [
                'ChannelArn' => '<string>',
                'LastMessageTimestamp' => <DateTime>,
                'Metadata' => '<string>',
                'Mode' => 'UNRESTRICTED|RESTRICTED',
                'Name' => '<string>',
                'Privacy' => 'PUBLIC|PRIVATE',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelMessages

$result = $client->listChannelMessages([/* ... */]);
$promise = $client->listChannelMessagesAsync([/* ... */]);

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Parameter Syntax

$result = $client->listChannelMessages([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'NotAfter' => <integer || string || DateTime>,
    'NotBefore' => <integer || string || DateTime>,
    'SortOrder' => 'ASCENDING|DESCENDING',
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ChannelMessages' => [
        [
            'Content' => '<string>',
            'ContentType' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'LastEditedTimestamp' => <DateTime>,
            'LastUpdatedTimestamp' => <DateTime>,
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'StringValues' => ['<string>', ...],
                ],
                // ...
            ],
            'MessageId' => '<string>',
            'Metadata' => '<string>',
            'Redacted' => true || false,
            'Sender' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
            'Status' => [
                'Detail' => '<string>',
                'Value' => 'SENT|PENDING|FAILED|DENIED',
            ],
            'Target' => [
                [
                    'MemberArn' => '<string>',
                ],
                // ...
            ],
            'Type' => 'STANDARD|CONTROL',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'SubChannelId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelModerators

$result = $client->listChannelModerators([/* ... */]);
$promise = $client->listChannelModeratorsAsync([/* ... */]);

Lists all the moderators for a channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ChannelModerators' => [
        [
            'Moderator' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

• Use privacy = PUBLIC to retrieve all public channels in the account.

• Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

Parameter Syntax

$result = $client->listChannels([
    'AppInstanceArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Privacy' => 'PUBLIC|PRIVATE',
]);

Parameter Details

Result Syntax

[
    'Channels' => [
        [
            'ChannelArn' => '<string>',
            'LastMessageTimestamp' => <DateTime>,
            'Metadata' => '<string>',
            'Mode' => 'UNRESTRICTED|RESTRICTED',
            'Name' => '<string>',
            'Privacy' => 'PUBLIC|PRIVATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelsAssociatedWithChannelFlow

$result = $client->listChannelsAssociatedWithChannelFlow([/* ... */]);
$promise = $client->listChannelsAssociatedWithChannelFlowAsync([/* ... */]);

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Channels' => [
        [
            'ChannelArn' => '<string>',
            'Metadata' => '<string>',
            'Mode' => 'UNRESTRICTED|RESTRICTED',
            'Name' => '<string>',
            'Privacy' => 'PUBLIC|PRIVATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListChannelsModeratedByAppInstanceUser

$result = $client->listChannelsModeratedByAppInstanceUser([/* ... */]);
$promise = $client->listChannelsModeratedByAppInstanceUserAsync([/* ... */]);

A list of the channels moderated by an AppInstanceUser.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Channels' => [
        [
            'ChannelSummary' => [
                'ChannelArn' => '<string>',
                'LastMessageTimestamp' => <DateTime>,
                'Metadata' => '<string>',
                'Mode' => 'UNRESTRICTED|RESTRICTED',
                'Name' => '<string>',
                'Privacy' => 'PUBLIC|PRIVATE',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListSubChannels

$result = $client->listSubChannels([/* ... */]);
$promise = $client->listSubChannelsAsync([/* ... */]);

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'NextToken' => '<string>',
    'SubChannels' => [
        [
            'MembershipCount' => <integer>,
            'SubChannelId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutChannelExpirationSettings

$result = $client->putChannelExpirationSettings([/* ... */]);
$promise = $client->putChannelExpirationSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putChannelExpirationSettings([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'ExpirationSettings' => [
        'ExpirationCriterion' => 'CREATED_TIMESTAMP|LAST_MESSAGE_TIMESTAMP', // REQUIRED
        'ExpirationDays' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ExpirationSettings' => [
        'ExpirationCriterion' => 'CREATED_TIMESTAMP|LAST_MESSAGE_TIMESTAMP',
        'ExpirationDays' => <integer>,
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutChannelMembershipPreferences

$result = $client->putChannelMembershipPreferences([/* ... */]);
$promise = $client->putChannelMembershipPreferencesAsync([/* ... */]);

Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.

Parameter Syntax

$result = $client->putChannelMembershipPreferences([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MemberArn' => '<string>', // REQUIRED
    'Preferences' => [ // REQUIRED
        'PushNotifications' => [
            'AllowNotifications' => 'ALL|NONE|FILTERED', // REQUIRED
            'FilterRule' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Member' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
    'Preferences' => [
        'PushNotifications' => [
            'AllowNotifications' => 'ALL|NONE|FILTERED',
            'FilterRule' => '<string>',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutMessagingStreamingConfigurations

$result = $client->putMessagingStreamingConfigurations([/* ... */]);
$promise = $client->putMessagingStreamingConfigurationsAsync([/* ... */]);

Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->putMessagingStreamingConfigurations([
    'AppInstanceArn' => '<string>', // REQUIRED
    'StreamingConfigurations' => [ // REQUIRED
        [
            'DataType' => 'Channel|ChannelMessage', // REQUIRED
            'ResourceArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'StreamingConfigurations' => [
        [
            'DataType' => 'Channel|ChannelMessage',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

RedactChannelMessage

$result = $client->redactChannelMessage([/* ... */]);
$promise = $client->redactChannelMessageAsync([/* ... */]);

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

Parameter Syntax

$result = $client->redactChannelMessage([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'MessageId' => '<string>',
    'SubChannelId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

SearchChannels

$result = $client->searchChannels([/* ... */]);
$promise = $client->searchChannelsAsync([/* ... */]);

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Parameter Syntax

$result = $client->searchChannels([
    'ChimeBearer' => '<string>',
    'Fields' => [ // REQUIRED
        [
            'Key' => 'MEMBERS', // REQUIRED
            'Operator' => 'EQUALS|INCLUDES', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Channels' => [
        [
            'ChannelArn' => '<string>',
            'LastMessageTimestamp' => <DateTime>,
            'Metadata' => '<string>',
            'Mode' => 'UNRESTRICTED|RESTRICTED',
            'Name' => '<string>',
            'Privacy' => 'PUBLIC|PRIVATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

SendChannelMessage

$result = $client->sendChannelMessage([/* ... */]);
$promise = $client->sendChannelMessageAsync([/* ... */]);

Sends a message to a particular channel that the member is a part of.

Parameter Syntax

$result = $client->sendChannelMessage([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'ContentType' => '<string>',
    'MessageAttributes' => [
        '<MessageAttributeName>' => [
            'StringValues' => ['<string>', ...],
        ],
        // ...
    ],
    'Metadata' => '<string>',
    'Persistence' => 'PERSISTENT|NON_PERSISTENT', // REQUIRED
    'PushNotification' => [
        'Body' => '<string>',
        'Title' => '<string>',
        'Type' => 'DEFAULT|VOIP',
    ],
    'SubChannelId' => '<string>',
    'Target' => [
        [
            'MemberArn' => '<string>',
        ],
        // ...
    ],
    'Type' => 'STANDARD|CONTROL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'MessageId' => '<string>',
    'Status' => [
        'Detail' => '<string>',
        'Value' => 'SENT|PENDING|FAILED|DENIED',
    ],
    'SubChannelId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateChannel

$result = $client->updateChannel([/* ... */]);
$promise = $client->updateChannelAsync([/* ... */]);

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

Parameter Syntax

$result = $client->updateChannel([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'Metadata' => '<string>',
    'Mode' => 'UNRESTRICTED|RESTRICTED',
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateChannelFlow

$result = $client->updateChannelFlow([/* ... */]);
$promise = $client->updateChannelFlowAsync([/* ... */]);

Updates channel flow attributes. This is a developer API.

Parameter Syntax

$result = $client->updateChannelFlow([
    'ChannelFlowArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Processors' => [ // REQUIRED
        [
            'Configuration' => [ // REQUIRED
                'Lambda' => [ // REQUIRED
                    'InvocationType' => 'ASYNC', // REQUIRED
                    'ResourceArn' => '<string>', // REQUIRED
                ],
            ],
            'ExecutionOrder' => <integer>, // REQUIRED
            'FallbackAction' => 'CONTINUE|ABORT', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateChannelMessage

$result = $client->updateChannelMessage([/* ... */]);
$promise = $client->updateChannelMessageAsync([/* ... */]);

Updates the content of a message.

Parameter Syntax

$result = $client->updateChannelMessage([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'ContentType' => '<string>',
    'MessageId' => '<string>', // REQUIRED
    'Metadata' => '<string>',
    'SubChannelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'MessageId' => '<string>',
    'Status' => [
        'Detail' => '<string>',
        'Value' => 'SENT|PENDING|FAILED|DENIED',
    ],
    'SubChannelId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateChannelReadMarker

$result = $client->updateChannelReadMarker([/* ... */]);
$promise = $client->updateChannelReadMarkerAsync([/* ... */]);

The details of the time when a user last read messages in a channel.

Parameter Syntax

$result = $client->updateChannelReadMarker([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.