# Amazon Chime SDK Messaging


The following actions are supported by Amazon Chime SDK Messaging:
+  [AssociateChannelFlow](API_messaging-chime_AssociateChannelFlow.md) 
+  [BatchCreateChannelMembership](API_messaging-chime_BatchCreateChannelMembership.md) 
+  [ChannelFlowCallback](API_messaging-chime_ChannelFlowCallback.md) 
+  [CreateChannel](API_messaging-chime_CreateChannel.md) 
+  [CreateChannelBan](API_messaging-chime_CreateChannelBan.md) 
+  [CreateChannelFlow](API_messaging-chime_CreateChannelFlow.md) 
+  [CreateChannelMembership](API_messaging-chime_CreateChannelMembership.md) 
+  [CreateChannelModerator](API_messaging-chime_CreateChannelModerator.md) 
+  [DeleteChannel](API_messaging-chime_DeleteChannel.md) 
+  [DeleteChannelBan](API_messaging-chime_DeleteChannelBan.md) 
+  [DeleteChannelFlow](API_messaging-chime_DeleteChannelFlow.md) 
+  [DeleteChannelMembership](API_messaging-chime_DeleteChannelMembership.md) 
+  [DeleteChannelMessage](API_messaging-chime_DeleteChannelMessage.md) 
+  [DeleteChannelModerator](API_messaging-chime_DeleteChannelModerator.md) 
+  [DeleteMessagingStreamingConfigurations](API_messaging-chime_DeleteMessagingStreamingConfigurations.md) 
+  [DescribeChannel](API_messaging-chime_DescribeChannel.md) 
+  [DescribeChannelBan](API_messaging-chime_DescribeChannelBan.md) 
+  [DescribeChannelFlow](API_messaging-chime_DescribeChannelFlow.md) 
+  [DescribeChannelMembership](API_messaging-chime_DescribeChannelMembership.md) 
+  [DescribeChannelMembershipForAppInstanceUser](API_messaging-chime_DescribeChannelMembershipForAppInstanceUser.md) 
+  [DescribeChannelModeratedByAppInstanceUser](API_messaging-chime_DescribeChannelModeratedByAppInstanceUser.md) 
+  [DescribeChannelModerator](API_messaging-chime_DescribeChannelModerator.md) 
+  [DisassociateChannelFlow](API_messaging-chime_DisassociateChannelFlow.md) 
+  [GetChannelMembershipPreferences](API_messaging-chime_GetChannelMembershipPreferences.md) 
+  [GetChannelMessage](API_messaging-chime_GetChannelMessage.md) 
+  [GetChannelMessageStatus](API_messaging-chime_GetChannelMessageStatus.md) 
+  [GetMessagingSessionEndpoint](API_messaging-chime_GetMessagingSessionEndpoint.md) 
+  [GetMessagingStreamingConfigurations](API_messaging-chime_GetMessagingStreamingConfigurations.md) 
+  [ListChannelBans](API_messaging-chime_ListChannelBans.md) 
+  [ListChannelFlows](API_messaging-chime_ListChannelFlows.md) 
+  [ListChannelMemberships](API_messaging-chime_ListChannelMemberships.md) 
+  [ListChannelMembershipsForAppInstanceUser](API_messaging-chime_ListChannelMembershipsForAppInstanceUser.md) 
+  [ListChannelMessages](API_messaging-chime_ListChannelMessages.md) 
+  [ListChannelModerators](API_messaging-chime_ListChannelModerators.md) 
+  [ListChannels](API_messaging-chime_ListChannels.md) 
+  [ListChannelsAssociatedWithChannelFlow](API_messaging-chime_ListChannelsAssociatedWithChannelFlow.md) 
+  [ListChannelsModeratedByAppInstanceUser](API_messaging-chime_ListChannelsModeratedByAppInstanceUser.md) 
+  [ListSubChannels](API_messaging-chime_ListSubChannels.md) 
+  [ListTagsForResource](API_messaging-chime_ListTagsForResource.md) 
+  [PutChannelExpirationSettings](API_messaging-chime_PutChannelExpirationSettings.md) 
+  [PutChannelMembershipPreferences](API_messaging-chime_PutChannelMembershipPreferences.md) 
+  [PutMessagingStreamingConfigurations](API_messaging-chime_PutMessagingStreamingConfigurations.md) 
+  [RedactChannelMessage](API_messaging-chime_RedactChannelMessage.md) 
+  [SearchChannels](API_messaging-chime_SearchChannels.md) 
+  [SendChannelMessage](API_messaging-chime_SendChannelMessage.md) 
+  [TagResource](API_messaging-chime_TagResource.md) 
+  [UntagResource](API_messaging-chime_UntagResource.md) 
+  [UpdateChannel](API_messaging-chime_UpdateChannel.md) 
+  [UpdateChannelFlow](API_messaging-chime_UpdateChannelFlow.md) 
+  [UpdateChannelMessage](API_messaging-chime_UpdateChannelMessage.md) 
+  [UpdateChannelReadMarker](API_messaging-chime_UpdateChannelReadMarker.md) 

# AssociateChannelFlow


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.

**Note**  
Only administrators or channel moderators can associate a channel flow. 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.

## Request Syntax


```
PUT /channels/channelArn/channel-flow HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "ChannelFlowArn": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_AssociateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_AssociateChannelFlow-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_AssociateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_AssociateChannelFlow-request-ChimeBearer"></a>
The `AppInstanceUserArn` of the user making the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [ChannelFlowArn](#API_messaging-chime_AssociateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_AssociateChannelFlow-request-ChannelFlowArn"></a>
The ARN of the channel flow.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Response Syntax


```
HTTP/1.1 200
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/AssociateChannelFlow) 

# BatchCreateChannelMembership


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

## Request Syntax


```
POST /channels/channelArn/memberships?operation=batch-create HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "MemberArns": [ "string" ],
   "SubChannelId": "string",
   "Type": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_BatchCreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-request-uri-ChannelArn"></a>
The ARN of the channel to which you're adding users or bots.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_BatchCreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [MemberArns](#API_messaging-chime_BatchCreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-request-MemberArns"></a>
The ARNs of the members you want to add to the channel. Only `AppInstanceUsers` and `AppInstanceBots` can be added as a channel member.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_BatchCreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-request-SubChannelId"></a>
The ID of the SubChannel in the request.   
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: No

 ** [Type](#API_messaging-chime_BatchCreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-request-Type"></a>
The membership type of a user, `DEFAULT` or `HIDDEN`. Default members are always returned as part of `ListChannelMemberships`. Hidden members are only returned if the type filter in `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are not returned. This is only supported by moderators.  
Type: String  
Valid Values: `DEFAULT | HIDDEN`   
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "BatchChannelMemberships": { 
      "ChannelArn": "string",
      "InvitedBy": { 
         "Arn": "string",
         "Name": "string"
      },
      "Members": [ 
         { 
            "Arn": "string",
            "Name": "string"
         }
      ],
      "SubChannelId": "string",
      "Type": "string"
   },
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "MemberArn": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BatchChannelMemberships](#API_messaging-chime_BatchCreateChannelMembership_ResponseSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-response-BatchChannelMemberships"></a>
The list of channel memberships in the response.  
Type: [BatchChannelMemberships](API_messaging-chime_BatchChannelMemberships.md) object

 ** [Errors](#API_messaging-chime_BatchCreateChannelMembership_ResponseSyntax) **   <a name="chimesdk-messaging-chime_BatchCreateChannelMembership-response-Errors"></a>
If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.  
Type: Array of [BatchCreateChannelMembershipError](API_messaging-chime_BatchCreateChannelMembershipError.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership) 

# ChannelFlowCallback


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

## Request Syntax


```
POST /channels/{channelArn}?operation=channel-flow-callback HTTP/1.1
Content-type: application/json

{
   "CallbackId": "string",
   "ChannelMessage": { 
      "Content": "string",
      "ContentType": "string",
      "MessageAttributes": { 
         "string" : { 
            "StringValues": [ "string" ]
         }
      },
      "MessageId": "string",
      "Metadata": "string",
      "PushNotification": { 
         "Body": "string",
         "Title": "string",
         "Type": "string"
      },
      "SubChannelId": "string"
   },
   "DeleteResource": boolean
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_ChannelFlowCallback_RequestSyntax) **   <a name="chimesdk-messaging-chime_ChannelFlowCallback-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [CallbackId](#API_messaging-chime_ChannelFlowCallback_RequestSyntax) **   <a name="chimesdk-messaging-chime_ChannelFlowCallback-request-CallbackId"></a>
The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 64.  
Required: Yes

 ** [ChannelMessage](#API_messaging-chime_ChannelFlowCallback_RequestSyntax) **   <a name="chimesdk-messaging-chime_ChannelFlowCallback-request-ChannelMessage"></a>
Stores information about the processed message.  
Type: [ChannelMessageCallback](API_messaging-chime_ChannelMessageCallback.md) object  
Required: Yes

 ** [DeleteResource](#API_messaging-chime_ChannelFlowCallback_RequestSyntax) **   <a name="chimesdk-messaging-chime_ChannelFlowCallback-request-DeleteResource"></a>
When a processor determines that a message needs to be `DENIED`, pass this parameter with a value of true.  
Type: Boolean  
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "CallbackId": "string",
   "ChannelArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CallbackId](#API_messaging-chime_ChannelFlowCallback_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ChannelFlowCallback-response-CallbackId"></a>
The call back ID passed in the request.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 64.

 ** [ChannelArn](#API_messaging-chime_ChannelFlowCallback_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ChannelFlowCallback-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ChannelFlowCallback) 

# CreateChannel


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

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

**Note**  
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.

## Request Syntax


```
POST /channels HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "AppInstanceArn": "string",
   "ChannelId": "string",
   "ClientRequestToken": "string",
   "ElasticChannelConfiguration": { 
      "MaximumSubChannels": number,
      "MinimumMembershipPercentage": number,
      "TargetMembershipsPerSubChannel": number
   },
   "ExpirationSettings": { 
      "ExpirationCriterion": "string",
      "ExpirationDays": number
   },
   "MemberArns": [ "string" ],
   "Metadata": "string",
   "Mode": "string",
   "ModeratorArns": [ "string" ],
   "Name": "string",
   "Privacy": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ChimeBearer](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [AppInstanceArn](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-AppInstanceArn"></a>
The ARN of the channel request.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChannelId](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-ChannelId"></a>
An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9]([A-Za-z0-9\:\-\_\.\@]{0,62}[A-Za-z0-9])?`   
Required: No

 ** [ClientRequestToken](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-ClientRequestToken"></a>
The client token for the request. An `Idempotency` token.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 64.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

 ** [ElasticChannelConfiguration](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-ElasticChannelConfiguration"></a>
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.  
Type: [ElasticChannelConfiguration](API_messaging-chime_ElasticChannelConfiguration.md) object  
Required: No

 ** [ExpirationSettings](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-ExpirationSettings"></a>
Settings that control the interval after which the channel is automatically deleted.  
Type: [ExpirationSettings](API_messaging-chime_ExpirationSettings.md) object  
Required: No

 ** [MemberArns](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-MemberArns"></a>
The ARNs of the channel members in the request.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [Metadata](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-Metadata"></a>
The metadata of the creation request. Limited to 1KB and UTF-8.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** [Mode](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-Mode"></a>
The channel mode: `UNRESTRICTED` or `RESTRICTED`. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.  
Type: String  
Valid Values: `UNRESTRICTED | RESTRICTED`   
Required: No

 ** [ModeratorArns](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-ModeratorArns"></a>
The ARNs of the channel moderators in the request.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [Name](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-Name"></a>
The name of the channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*`   
Required: Yes

 ** [Privacy](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-Privacy"></a>
The channel's privacy level: `PUBLIC` or `PRIVATE`. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the `AppInstance`.  
Type: String  
Valid Values: `PUBLIC | PRIVATE`   
Required: No

 ** [Tags](#API_messaging-chime_CreateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-request-Tags"></a>
The tags for the creation request.  
Type: Array of [Tag](API_messaging-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "ChannelArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_CreateChannel_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannel-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/CreateChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/CreateChannel) 

# CreateChannelBan


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.

**Note**  
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.

## Request Syntax


```
POST /channels/channelArn/bans HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "MemberArn": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_CreateChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelBan-request-uri-ChannelArn"></a>
The ARN of the ban request.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_CreateChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelBan-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [MemberArn](#API_messaging-chime_CreateChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelBan-request-MemberArn"></a>
The `AppInstanceUserArn` of the member being banned.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "ChannelArn": "string",
   "Member": { 
      "Arn": "string",
      "Name": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_CreateChannelBan_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelBan-response-ChannelArn"></a>
The ARN of the response to the ban request.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [Member](#API_messaging-chime_CreateChannelBan_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelBan-response-Member"></a>
The `ChannelArn` and `BannedIdentity` of the member in the ban response.  
Type: [Identity](API_messaging-chime_Identity.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/CreateChannelBan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/CreateChannelBan) 

# CreateChannelFlow


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

1. Persistent and non-persistent messages

1. The Standard message type

**Note**  
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to [Message types](https://docs.aws.amazon.com/chime-sdk/latest/dg/using-the-messaging-sdk.html#msg-types) in the *Amazon Chime developer guide*.

## Request Syntax


```
POST /channel-flows HTTP/1.1
Content-type: application/json

{
   "AppInstanceArn": "string",
   "ClientRequestToken": "string",
   "Name": "string",
   "Processors": [ 
      { 
         "Configuration": { 
            "Lambda": { 
               "InvocationType": "string",
               "ResourceArn": "string"
            }
         },
         "ExecutionOrder": number,
         "FallbackAction": "string",
         "Name": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [AppInstanceArn](#API_messaging-chime_CreateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelFlow-request-AppInstanceArn"></a>
The ARN of the channel flow request.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ClientRequestToken](#API_messaging-chime_CreateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelFlow-request-ClientRequestToken"></a>
The client token for the request. An Idempotency token.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 64.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

 ** [Name](#API_messaging-chime_CreateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelFlow-request-Name"></a>
The name of the channel flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*`   
Required: Yes

 ** [Processors](#API_messaging-chime_CreateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelFlow-request-Processors"></a>
Information about the processor Lambda functions.  
Type: Array of [Processor](API_messaging-chime_Processor.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Required: Yes

 ** [Tags](#API_messaging-chime_CreateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelFlow-request-Tags"></a>
The tags for the creation request.  
Type: Array of [Tag](API_messaging-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "ChannelFlowArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ChannelFlowArn](#API_messaging-chime_CreateChannelFlow_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelFlow-response-ChannelFlowArn"></a>
The ARN of the channel flow.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/CreateChannelFlow) 

# CreateChannelMembership


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.

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

## Request Syntax


```
POST /channels/channelArn/memberships HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "MemberArn": "string",
   "SubChannelId": "string",
   "Type": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_CreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-request-uri-ChannelArn"></a>
The ARN of the channel to which you're adding users.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_CreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [MemberArn](#API_messaging-chime_CreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-request-MemberArn"></a>
The `AppInstanceUserArn` of the member you want to add to the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_CreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-request-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: No

 ** [Type](#API_messaging-chime_CreateChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-request-Type"></a>
The membership type of a user, `DEFAULT` or `HIDDEN`. Default members are always returned as part of `ListChannelMemberships`. Hidden members are only returned if the type filter in `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are not returned. This is only supported by moderators.  
Type: String  
Valid Values: `DEFAULT | HIDDEN`   
Required: Yes

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "ChannelArn": "string",
   "Member": { 
      "Arn": "string",
      "Name": "string"
   },
   "SubChannelId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_CreateChannelMembership_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [Member](#API_messaging-chime_CreateChannelMembership_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-response-Member"></a>
The ARN and metadata of the member being added.  
Type: [Identity](API_messaging-chime_Identity.md) object

 ** [SubChannelId](#API_messaging-chime_CreateChannelMembership_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelMembership-response-SubChannelId"></a>
The ID of the SubChannel in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/CreateChannelMembership) 

# CreateChannelModerator


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.

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

## Request Syntax


```
POST /channels/channelArn/moderators HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "ChannelModeratorArn": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_CreateChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelModerator-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_CreateChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelModerator-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [ChannelModeratorArn](#API_messaging-chime_CreateChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelModerator-request-ChannelModeratorArn"></a>
The `AppInstanceUserArn` of the moderator.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelModerator": { 
      "Arn": "string",
      "Name": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_CreateChannelModerator_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelModerator-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChannelModerator](#API_messaging-chime_CreateChannelModerator_ResponseSyntax) **   <a name="chimesdk-messaging-chime_CreateChannelModerator-response-ChannelModerator"></a>
The ARNs of the channel and the moderator.  
Type: [Identity](API_messaging-chime_Identity.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/CreateChannelModerator) 

# DeleteChannel


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

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

## Request Syntax


```
DELETE /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DeleteChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannel-request-uri-ChannelArn"></a>
The ARN of the channel being deleted.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DeleteChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannel-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteChannel) 

# DeleteChannelBan


Removes a member from a channel's ban list.

**Note**  
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.

## Request Syntax


```
DELETE /channels/channelArn/bans/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DeleteChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelBan-request-uri-ChannelArn"></a>
The ARN of the channel from which the `AppInstanceUser` was banned.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DeleteChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelBan-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [memberArn](#API_messaging-chime_DeleteChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelBan-request-uri-MemberArn"></a>
The ARN of the `AppInstanceUser` that you want to reinstate.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteChannelBan) 

# DeleteChannelFlow


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

**Note**  
 This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the `ListChannelsAssociatedWithChannelFlow` API. Use the `DisassociateChannelFlow` API to disassociate a channel flow from all channels. 

## Request Syntax


```
DELETE /channel-flows/channelFlowArn HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelFlowArn](#API_messaging-chime_DeleteChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelFlow-request-uri-ChannelFlowArn"></a>
The ARN of the channel flow.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteChannelFlow) 

# DeleteChannelMembership


Removes a member from a channel.

**Note**  
The `x-amz-chime-bearer` request header is mandatory. Use the `AppInstanceUserArn` of the user that makes the API call as the value in the header.

## Request Syntax


```
DELETE /channels/channelArn/memberships/memberArn?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DeleteChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMembership-request-uri-ChannelArn"></a>
The ARN of the channel from which you want to remove the user.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DeleteChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMembership-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [memberArn](#API_messaging-chime_DeleteChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMembership-request-uri-MemberArn"></a>
The `AppInstanceUserArn` of the member that you're removing from the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_DeleteChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMembership-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only for use by moderators.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteChannelMembership) 

# DeleteChannelMessage


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

**Note**  
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.

## Request Syntax


```
DELETE /channels/channelArn/messages/messageId?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DeleteChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMessage-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DeleteChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMessage-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [messageId](#API_messaging-chime_DeleteChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMessage-request-uri-MessageId"></a>
The ID of the message being deleted.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_DeleteChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelMessage-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when deleting messages in a SubChannel that the user belongs to.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteChannelMessage) 

# DeleteChannelModerator


Deletes a channel moderator.

**Note**  
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.

## Request Syntax


```
DELETE /channels/channelArn/moderators/channelModeratorArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DeleteChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelModerator-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [channelModeratorArn](#API_messaging-chime_DeleteChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelModerator-request-uri-ChannelModeratorArn"></a>
The `AppInstanceUserArn` of the moderator being deleted.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DeleteChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteChannelModerator-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteChannelModerator) 

# DeleteMessagingStreamingConfigurations


Deletes the streaming configurations for an `AppInstance`. For more information, see [Streaming messaging data](https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the *Amazon Chime SDK Developer Guide*.

## Request Syntax


```
DELETE /app-instances/appInstanceArn/streaming-configurations HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [appInstanceArn](#API_messaging-chime_DeleteMessagingStreamingConfigurations_RequestSyntax) **   <a name="chimesdk-messaging-chime_DeleteMessagingStreamingConfigurations-request-uri-AppInstanceArn"></a>
The ARN of the streaming configurations being deleted.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations) 

# DescribeChannel


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

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DescribeChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannel-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DescribeChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannel-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Channel": { 
      "ChannelArn": "string",
      "ChannelFlowArn": "string",
      "CreatedBy": { 
         "Arn": "string",
         "Name": "string"
      },
      "CreatedTimestamp": number,
      "ElasticChannelConfiguration": { 
         "MaximumSubChannels": number,
         "MinimumMembershipPercentage": number,
         "TargetMembershipsPerSubChannel": number
      },
      "ExpirationSettings": { 
         "ExpirationCriterion": "string",
         "ExpirationDays": number
      },
      "LastMessageTimestamp": number,
      "LastUpdatedTimestamp": number,
      "Metadata": "string",
      "Mode": "string",
      "Name": "string",
      "Privacy": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channel](#API_messaging-chime_DescribeChannel_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannel-response-Channel"></a>
The channel details.  
Type: [Channel](API_messaging-chime_Channel.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannel) 

# DescribeChannelBan


Returns the full details of a channel ban.

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn/bans/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DescribeChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelBan-request-uri-ChannelArn"></a>
The ARN of the channel from which the user is banned.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DescribeChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelBan-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [memberArn](#API_messaging-chime_DescribeChannelBan_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelBan-request-uri-MemberArn"></a>
The `AppInstanceUserArn` of the member being banned.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelBan": { 
      "ChannelArn": "string",
      "CreatedBy": { 
         "Arn": "string",
         "Name": "string"
      },
      "CreatedTimestamp": number,
      "Member": { 
         "Arn": "string",
         "Name": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelBan](#API_messaging-chime_DescribeChannelBan_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelBan-response-ChannelBan"></a>
The details of the ban.  
Type: [ChannelBan](API_messaging-chime_ChannelBan.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannelBan) 

# DescribeChannelFlow


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

## Request Syntax


```
GET /channel-flows/channelFlowArn HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelFlowArn](#API_messaging-chime_DescribeChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelFlow-request-uri-ChannelFlowArn"></a>
The ARN of the channel flow.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelFlow": { 
      "ChannelFlowArn": "string",
      "CreatedTimestamp": number,
      "LastUpdatedTimestamp": number,
      "Name": "string",
      "Processors": [ 
         { 
            "Configuration": { 
               "Lambda": { 
                  "InvocationType": "string",
                  "ResourceArn": "string"
               }
            },
            "ExecutionOrder": number,
            "FallbackAction": "string",
            "Name": "string"
         }
      ]
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelFlow](#API_messaging-chime_DescribeChannelFlow_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelFlow-response-ChannelFlow"></a>
The channel flow details.  
Type: [ChannelFlow](API_messaging-chime_ChannelFlow.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannelFlow) 

# DescribeChannelMembership


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

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn/memberships/memberArn?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DescribeChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembership-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DescribeChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembership-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [memberArn](#API_messaging-chime_DescribeChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembership-request-uri-MemberArn"></a>
The `AppInstanceUserArn` of the member.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_DescribeChannelMembership_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembership-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request. The response contains an `ElasticChannelConfiguration` object.  
Only required to get a user’s SubChannel membership details.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelMembership": { 
      "ChannelArn": "string",
      "CreatedTimestamp": number,
      "InvitedBy": { 
         "Arn": "string",
         "Name": "string"
      },
      "LastUpdatedTimestamp": number,
      "Member": { 
         "Arn": "string",
         "Name": "string"
      },
      "SubChannelId": "string",
      "Type": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelMembership](#API_messaging-chime_DescribeChannelMembership_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembership-response-ChannelMembership"></a>
The details of the membership.  
Type: [ChannelMembership](API_messaging-chime_ChannelMembership.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannelMembership) 

# DescribeChannelMembershipForAppInstanceUser


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

**Note**  
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.

## Request Syntax


```
GET /channels/{channelArn}?scope=app-instance-user-membership&app-instance-user-arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AppInstanceUserArn](#API_messaging-chime_DescribeChannelMembershipForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembershipForAppInstanceUser-request-uri-AppInstanceUserArn"></a>
The ARN of the user or bot in a channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [channelArn](#API_messaging-chime_DescribeChannelMembershipForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembershipForAppInstanceUser-request-uri-ChannelArn"></a>
The ARN of the channel to which the user belongs.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DescribeChannelMembershipForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembershipForAppInstanceUser-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelMembership": { 
      "AppInstanceUserMembershipSummary": { 
         "ReadMarkerTimestamp": number,
         "SubChannelId": "string",
         "Type": "string"
      },
      "ChannelSummary": { 
         "ChannelArn": "string",
         "LastMessageTimestamp": number,
         "Metadata": "string",
         "Mode": "string",
         "Name": "string",
         "Privacy": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelMembership](#API_messaging-chime_DescribeChannelMembershipForAppInstanceUser_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelMembershipForAppInstanceUser-response-ChannelMembership"></a>
The channel to which a user belongs.  
Type: [ChannelMembershipForAppInstanceUserSummary](API_messaging-chime_ChannelMembershipForAppInstanceUserSummary.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser) 

# DescribeChannelModeratedByAppInstanceUser


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

**Note**  
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.

## Request Syntax


```
GET /channels/{channelArn}?scope=app-instance-user-moderated-channel&app-instance-user-arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AppInstanceUserArn](#API_messaging-chime_DescribeChannelModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModeratedByAppInstanceUser-request-uri-AppInstanceUserArn"></a>
The ARN of the user or bot in the moderated channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [channelArn](#API_messaging-chime_DescribeChannelModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModeratedByAppInstanceUser-request-uri-ChannelArn"></a>
The ARN of the moderated channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DescribeChannelModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModeratedByAppInstanceUser-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Channel": { 
      "ChannelSummary": { 
         "ChannelArn": "string",
         "LastMessageTimestamp": number,
         "Metadata": "string",
         "Mode": "string",
         "Name": "string",
         "Privacy": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channel](#API_messaging-chime_DescribeChannelModeratedByAppInstanceUser_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModeratedByAppInstanceUser-response-Channel"></a>
The moderated channel.  
Type: [ChannelModeratedByAppInstanceUserSummary](API_messaging-chime_ChannelModeratedByAppInstanceUserSummary.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser) 

# DescribeChannelModerator


Returns the full details of a single ChannelModerator.

**Note**  
The `x-amz-chime-bearer` request header is mandatory. Use the `AppInstanceUserArn` of the user that makes the API call as the value in the header.

## Request Syntax


```
GET /channels/channelArn/moderators/channelModeratorArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DescribeChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModerator-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [channelModeratorArn](#API_messaging-chime_DescribeChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModerator-request-uri-ChannelModeratorArn"></a>
The `AppInstanceUserArn` of the channel moderator.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DescribeChannelModerator_RequestSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModerator-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelModerator": { 
      "ChannelArn": "string",
      "CreatedBy": { 
         "Arn": "string",
         "Name": "string"
      },
      "CreatedTimestamp": number,
      "Moderator": { 
         "Arn": "string",
         "Name": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelModerator](#API_messaging-chime_DescribeChannelModerator_ResponseSyntax) **   <a name="chimesdk-messaging-chime_DescribeChannelModerator-response-ChannelModerator"></a>
The details of the channel moderator.  
Type: [ChannelModerator](API_messaging-chime_ChannelModerator.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DescribeChannelModerator) 

# DisassociateChannelFlow


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

**Note**  
Only administrators or channel moderators can disassociate a channel flow.  
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.

## Request Syntax


```
DELETE /channels/channelArn/channel-flow/channelFlowArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_DisassociateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_DisassociateChannelFlow-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [channelFlowArn](#API_messaging-chime_DisassociateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_DisassociateChannelFlow-request-uri-ChannelFlowArn"></a>
The ARN of the channel flow.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_DisassociateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_DisassociateChannelFlow-request-ChimeBearer"></a>
The `AppInstanceUserArn` of the user making the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow) 

# GetChannelMembershipPreferences


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.

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn/memberships/memberArn/preferences HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_GetChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMembershipPreferences-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_GetChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMembershipPreferences-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [memberArn](#API_messaging-chime_GetChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMembershipPreferences-request-uri-MemberArn"></a>
The `AppInstanceUserArn` of the member retrieving the preferences.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "Member": { 
      "Arn": "string",
      "Name": "string"
   },
   "Preferences": { 
      "PushNotifications": { 
         "AllowNotifications": "string",
         "FilterRule": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_GetChannelMembershipPreferences_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMembershipPreferences-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [Member](#API_messaging-chime_GetChannelMembershipPreferences_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMembershipPreferences-response-Member"></a>
The details of a user.  
Type: [Identity](API_messaging-chime_Identity.md) object

 ** [Preferences](#API_messaging-chime_GetChannelMembershipPreferences_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMembershipPreferences-response-Preferences"></a>
The channel membership preferences for an `AppInstanceUser` .  
Type: [ChannelMembershipPreferences](API_messaging-chime_ChannelMembershipPreferences.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences) 

# GetChannelMessage


Gets the full details of a channel message.

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn/messages/messageId?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_GetChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessage-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_GetChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessage-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [messageId](#API_messaging-chime_GetChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessage-request-uri-MessageId"></a>
The ID of the message.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_GetChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessage-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when getting messages in a SubChannel that the user belongs to.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelMessage": { 
      "ChannelArn": "string",
      "Content": "string",
      "ContentType": "string",
      "CreatedTimestamp": number,
      "LastEditedTimestamp": number,
      "LastUpdatedTimestamp": number,
      "MessageAttributes": { 
         "string" : { 
            "StringValues": [ "string" ]
         }
      },
      "MessageId": "string",
      "Metadata": "string",
      "Persistence": "string",
      "Redacted": boolean,
      "Sender": { 
         "Arn": "string",
         "Name": "string"
      },
      "Status": { 
         "Detail": "string",
         "Value": "string"
      },
      "SubChannelId": "string",
      "Target": [ 
         { 
            "MemberArn": "string"
         }
      ],
      "Type": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelMessage](#API_messaging-chime_GetChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessage-response-ChannelMessage"></a>
The details of and content in the message.  
Type: [ChannelMessage](API_messaging-chime_ChannelMessage.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/GetChannelMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/GetChannelMessage) 

# GetChannelMessageStatus


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

**Note**  
This API does not return statuses for denied messages, because we don't store them once the processor denies them. 
Only the message sender can invoke this API.
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.

## Request Syntax


```
GET /channels/channelArn/messages/{messageId}?scope=message-status&sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_GetChannelMessageStatus_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessageStatus-request-uri-ChannelArn"></a>
The ARN of the channel  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_GetChannelMessageStatus_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessageStatus-request-ChimeBearer"></a>
The `AppInstanceUserArn` of the user making the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [messageId](#API_messaging-chime_GetChannelMessageStatus_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessageStatus-request-uri-MessageId"></a>
The ID of the message.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

 ** [SubChannelId](#API_messaging-chime_GetChannelMessageStatus_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessageStatus-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when getting message status in a SubChannel that the user belongs to.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Status": { 
      "Detail": "string",
      "Value": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Status](#API_messaging-chime_GetChannelMessageStatus_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetChannelMessageStatus-response-Status"></a>
The message status and details.  
Type: [ChannelMessageStatusStructure](API_messaging-chime_ChannelMessageStatusStructure.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus) 

# GetMessagingSessionEndpoint


The details of the endpoint for the messaging session.

## Request Syntax


```
GET /endpoints/messaging-session?network-type=NetworkType HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [NetworkType](#API_messaging-chime_GetMessagingSessionEndpoint_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetMessagingSessionEndpoint-request-uri-NetworkType"></a>
The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).  
Valid Values: `IPV4_ONLY | DUAL_STACK` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Endpoint": { 
      "Url": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Endpoint](#API_messaging-chime_GetMessagingSessionEndpoint_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetMessagingSessionEndpoint-response-Endpoint"></a>
The endpoint returned in the response.  
Type: [MessagingSessionEndpoint](API_messaging-chime_MessagingSessionEndpoint.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint) 

# GetMessagingStreamingConfigurations


Retrieves the data streaming configuration for an `AppInstance`. For more information, see [Streaming messaging data](https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the *Amazon Chime SDK Developer Guide*.

## Request Syntax


```
GET /app-instances/appInstanceArn/streaming-configurations HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [appInstanceArn](#API_messaging-chime_GetMessagingStreamingConfigurations_RequestSyntax) **   <a name="chimesdk-messaging-chime_GetMessagingStreamingConfigurations-request-uri-AppInstanceArn"></a>
The ARN of the streaming configurations.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "StreamingConfigurations": [ 
      { 
         "DataType": "string",
         "ResourceArn": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StreamingConfigurations](#API_messaging-chime_GetMessagingStreamingConfigurations_ResponseSyntax) **   <a name="chimesdk-messaging-chime_GetMessagingStreamingConfigurations-response-StreamingConfigurations"></a>
The streaming settings.  
Type: Array of [StreamingConfiguration](API_messaging-chime_StreamingConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations) 

# ListChannelBans


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

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn/bans?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_ListChannelBans_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_ListChannelBans_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelBans_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-request-uri-MaxResults"></a>
The maximum number of bans that you want returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelBans_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-request-uri-NextToken"></a>
The token passed by previous API calls until all requested bans are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelBans": [ 
      { 
         "Member": { 
            "Arn": "string",
            "Name": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_ListChannelBans_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChannelBans](#API_messaging-chime_ListChannelBans_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-response-ChannelBans"></a>
The information for each requested ban.  
Type: Array of [ChannelBanSummary](API_messaging-chime_ChannelBanSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelBans_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelBans-response-NextToken"></a>
The token passed by previous API calls until all requested bans are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelBans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelBans) 

# ListChannelFlows


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

## Request Syntax


```
GET /channel-flows?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AppInstanceArn](#API_messaging-chime_ListChannelFlows_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelFlows-request-uri-AppInstanceArn"></a>
The ARN of the app instance.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelFlows_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelFlows-request-uri-MaxResults"></a>
The maximum number of channel flows that you want to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelFlows_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelFlows-request-uri-NextToken"></a>
The token passed by previous API calls until all requested channel flows are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelFlows": [ 
      { 
         "ChannelFlowArn": "string",
         "Name": "string",
         "Processors": [ 
            { 
               "Configuration": { 
                  "Lambda": { 
                     "InvocationType": "string",
                     "ResourceArn": "string"
                  }
               },
               "ExecutionOrder": number,
               "FallbackAction": "string",
               "Name": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelFlows](#API_messaging-chime_ListChannelFlows_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelFlows-response-ChannelFlows"></a>
The information about each channel flow.  
Type: Array of [ChannelFlowSummary](API_messaging-chime_ChannelFlowSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelFlows_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelFlows-response-NextToken"></a>
The token passed by previous API calls until all requested channels are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelFlows) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelFlows) 

# ListChannelMemberships


Lists all channel memberships in a channel.

**Note**  
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.

If you want to list the channels to which a specific app instance user belongs, see the [ListChannelMembershipsForAppInstanceUser](https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html) API.

## Request Syntax


```
GET /channels/channelArn/memberships?max-results=MaxResults&next-token=NextToken&sub-channel-id=SubChannelId&type=Type HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_ListChannelMemberships_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-request-uri-ChannelArn"></a>
The maximum number of channel memberships that you want returned.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_ListChannelMemberships_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelMemberships_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-request-uri-MaxResults"></a>
The maximum number of channel memberships that you want returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelMemberships_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-request-uri-NextToken"></a>
The token passed by previous API calls until all requested channel memberships are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

 ** [SubChannelId](#API_messaging-chime_ListChannelMemberships_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when listing a user's memberships in a particular sub-channel of an elastic channel.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

 ** [Type](#API_messaging-chime_ListChannelMemberships_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-request-uri-Type"></a>
The membership type of a user, `DEFAULT` or `HIDDEN`. Default members are returned as part of `ListChannelMemberships` if no type is specified. Hidden members are only returned if the type filter in `ListChannelMemberships` equals `HIDDEN`.  
Valid Values: `DEFAULT | HIDDEN` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelMemberships": [ 
      { 
         "Member": { 
            "Arn": "string",
            "Name": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_ListChannelMemberships_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChannelMemberships](#API_messaging-chime_ListChannelMemberships_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-response-ChannelMemberships"></a>
The information for the requested channel memberships.  
Type: Array of [ChannelMembershipSummary](API_messaging-chime_ChannelMembershipSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelMemberships_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMemberships-response-NextToken"></a>
The token passed by previous API calls until all requested channel memberships are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelMemberships) 

# ListChannelMembershipsForAppInstanceUser


 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. 

**Note**  
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.

## Request Syntax


```
GET /channels?scope=app-instance-user-memberships&app-instance-user-arn=AppInstanceUserArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AppInstanceUserArn](#API_messaging-chime_ListChannelMembershipsForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMembershipsForAppInstanceUser-request-uri-AppInstanceUserArn"></a>
The ARN of the user or bot.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChimeBearer](#API_messaging-chime_ListChannelMembershipsForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMembershipsForAppInstanceUser-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelMembershipsForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMembershipsForAppInstanceUser-request-uri-MaxResults"></a>
The maximum number of users that you want returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelMembershipsForAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMembershipsForAppInstanceUser-request-uri-NextToken"></a>
The token returned from previous API requests until the number of channel memberships is reached.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelMemberships": [ 
      { 
         "AppInstanceUserMembershipSummary": { 
            "ReadMarkerTimestamp": number,
            "SubChannelId": "string",
            "Type": "string"
         },
         "ChannelSummary": { 
            "ChannelArn": "string",
            "LastMessageTimestamp": number,
            "Metadata": "string",
            "Mode": "string",
            "Name": "string",
            "Privacy": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelMemberships](#API_messaging-chime_ListChannelMembershipsForAppInstanceUser_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMembershipsForAppInstanceUser-response-ChannelMemberships"></a>
The information for the requested channel memberships.  
Type: Array of [ChannelMembershipForAppInstanceUserSummary](API_messaging-chime_ChannelMembershipForAppInstanceUserSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelMembershipsForAppInstanceUser_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMembershipsForAppInstanceUser-response-NextToken"></a>
The token passed by previous API calls until all requested users are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser) 

# ListChannelMessages


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

**Note**  
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.  
Also, 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.

## Request Syntax


```
GET /channels/channelArn/messages?max-results=MaxResults&next-token=NextToken&not-after=NotAfter&not-before=NotBefore&sort-order=SortOrder&sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-MaxResults"></a>
The maximum number of messages that you want returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-NextToken"></a>
The token passed by previous API calls until all requested messages are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

 ** [NotAfter](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-NotAfter"></a>
The final or ending time stamp for your requested messages.

 ** [NotBefore](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-NotBefore"></a>
The initial or starting time stamp for your requested messages.

 ** [SortOrder](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-SortOrder"></a>
The order in which you want messages sorted. Default is Descending, based on time created.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [SubChannelId](#API_messaging-chime_ListChannelMessages_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-request-uri-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when listing the messages in a SubChannel that the user belongs to.
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelMessages": [ 
      { 
         "Content": "string",
         "ContentType": "string",
         "CreatedTimestamp": number,
         "LastEditedTimestamp": number,
         "LastUpdatedTimestamp": number,
         "MessageAttributes": { 
            "string" : { 
               "StringValues": [ "string" ]
            }
         },
         "MessageId": "string",
         "Metadata": "string",
         "Redacted": boolean,
         "Sender": { 
            "Arn": "string",
            "Name": "string"
         },
         "Status": { 
            "Detail": "string",
            "Value": "string"
         },
         "Target": [ 
            { 
               "MemberArn": "string"
            }
         ],
         "Type": "string"
      }
   ],
   "NextToken": "string",
   "SubChannelId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_ListChannelMessages_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-response-ChannelArn"></a>
The ARN of the channel containing the requested messages.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChannelMessages](#API_messaging-chime_ListChannelMessages_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-response-ChannelMessages"></a>
The information about, and content of, each requested message.  
Type: Array of [ChannelMessageSummary](API_messaging-chime_ChannelMessageSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelMessages_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-response-NextToken"></a>
The token passed by previous API calls until all requested messages are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

 ** [SubChannelId](#API_messaging-chime_ListChannelMessages_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelMessages-response-SubChannelId"></a>
The ID of the SubChannel in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelMessages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelMessages) 

# ListChannelModerators


Lists all the moderators for a channel.

**Note**  
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.

## Request Syntax


```
GET /channels/channelArn/moderators?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_ListChannelModerators_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_ListChannelModerators_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelModerators_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-request-uri-MaxResults"></a>
The maximum number of moderators that you want returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelModerators_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-request-uri-NextToken"></a>
The token passed by previous API calls until all requested moderators are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelModerators": [ 
      { 
         "Moderator": { 
            "Arn": "string",
            "Name": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_ListChannelModerators_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChannelModerators](#API_messaging-chime_ListChannelModerators_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-response-ChannelModerators"></a>
The information about and names of each moderator.  
Type: Array of [ChannelModeratorSummary](API_messaging-chime_ChannelModeratorSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelModerators_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelModerators-response-NextToken"></a>
The token passed by previous API calls until all requested moderators are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelModerators) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelModerators) 

# ListChannels


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.

**Note**  
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.

## Request Syntax


```
GET /channels?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-token=NextToken&privacy=Privacy HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AppInstanceArn](#API_messaging-chime_ListChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-request-uri-AppInstanceArn"></a>
The ARN of the `AppInstance`.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_ListChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-request-uri-MaxResults"></a>
The maximum number of channels that you want to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-request-uri-NextToken"></a>
The token passed by previous API calls until all requested channels are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

 ** [Privacy](#API_messaging-chime_ListChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-request-uri-Privacy"></a>
The privacy setting. `PUBLIC` retrieves all the public channels. `PRIVATE` retrieves private channels. Only an `AppInstanceAdmin` can retrieve private channels.   
Valid Values: `PUBLIC | PRIVATE` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Channels": [ 
      { 
         "ChannelArn": "string",
         "LastMessageTimestamp": number,
         "Metadata": "string",
         "Mode": "string",
         "Name": "string",
         "Privacy": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channels](#API_messaging-chime_ListChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-response-Channels"></a>
The information about each channel.  
Type: Array of [ChannelSummary](API_messaging-chime_ChannelSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannels-response-NextToken"></a>
The token returned from previous API requests until the number of channels is reached.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannels) 

# ListChannelsAssociatedWithChannelFlow


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.

## Request Syntax


```
GET /channels?scope=channel-flow-associations&channel-flow-arn=ChannelFlowArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ChannelFlowArn](#API_messaging-chime_ListChannelsAssociatedWithChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsAssociatedWithChannelFlow-request-uri-ChannelFlowArn"></a>
The ARN of the channel flow.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelsAssociatedWithChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsAssociatedWithChannelFlow-request-uri-MaxResults"></a>
The maximum number of channels that you want to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelsAssociatedWithChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsAssociatedWithChannelFlow-request-uri-NextToken"></a>
The token passed by previous API calls until all requested channels are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Channels": [ 
      { 
         "ChannelArn": "string",
         "Metadata": "string",
         "Mode": "string",
         "Name": "string",
         "Privacy": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channels](#API_messaging-chime_ListChannelsAssociatedWithChannelFlow_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsAssociatedWithChannelFlow-response-Channels"></a>
The information about each channel.  
Type: Array of [ChannelAssociatedWithFlowSummary](API_messaging-chime_ChannelAssociatedWithFlowSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelsAssociatedWithChannelFlow_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsAssociatedWithChannelFlow-response-NextToken"></a>
The token passed by previous API calls until all requested channels are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow) 

# ListChannelsModeratedByAppInstanceUser


A list of the channels moderated by an `AppInstanceUser`.

**Note**  
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.

## Request Syntax


```
GET /channels?scope=app-instance-user-moderated-channels&app-instance-user-arn=AppInstanceUserArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AppInstanceUserArn](#API_messaging-chime_ListChannelsModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsModeratedByAppInstanceUser-request-uri-AppInstanceUserArn"></a>
The ARN of the user or bot in the moderated channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ChimeBearer](#API_messaging-chime_ListChannelsModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsModeratedByAppInstanceUser-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListChannelsModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsModeratedByAppInstanceUser-request-uri-MaxResults"></a>
The maximum number of channels in the request.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListChannelsModeratedByAppInstanceUser_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsModeratedByAppInstanceUser-request-uri-NextToken"></a>
The token returned from previous API requests until the number of channels moderated by the user is reached.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Channels": [ 
      { 
         "ChannelSummary": { 
            "ChannelArn": "string",
            "LastMessageTimestamp": number,
            "Metadata": "string",
            "Mode": "string",
            "Name": "string",
            "Privacy": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channels](#API_messaging-chime_ListChannelsModeratedByAppInstanceUser_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsModeratedByAppInstanceUser-response-Channels"></a>
The moderated channels in the request.  
Type: Array of [ChannelModeratedByAppInstanceUserSummary](API_messaging-chime_ChannelModeratedByAppInstanceUserSummary.md) objects

 ** [NextToken](#API_messaging-chime_ListChannelsModeratedByAppInstanceUser_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListChannelsModeratedByAppInstanceUser-response-NextToken"></a>
The token returned from previous API requests until the number of channels moderated by the user is reached.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser) 

# ListSubChannels


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.

## Request Syntax


```
GET /channels/channelArn/subchannels?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_ListSubChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-request-uri-ChannelArn"></a>
The ARN of elastic channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_ListSubChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-request-ChimeBearer"></a>
The `AppInstanceUserArn` of the user making the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [MaxResults](#API_messaging-chime_ListSubChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-request-uri-MaxResults"></a>
The maximum number of sub-channels that you want to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_ListSubChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-request-uri-NextToken"></a>
The token passed by previous API calls until all requested sub-channels are returned.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "NextToken": "string",
   "SubChannels": [ 
      { 
         "MembershipCount": number,
         "SubChannelId": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_ListSubChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-response-ChannelArn"></a>
The ARN of elastic channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [NextToken](#API_messaging-chime_ListSubChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-response-NextToken"></a>
The token passed by previous API calls until all requested sub-channels are returned.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

 ** [SubChannels](#API_messaging-chime_ListSubChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListSubChannels-response-SubChannels"></a>
The information about each sub-channel.  
Type: Array of [SubChannelSummary](API_messaging-chime_SubChannelSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListSubChannels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListSubChannels) 

# ListTagsForResource


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

## Request Syntax


```
GET /tags?arn=ResourceARN HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ResourceARN](#API_messaging-chime_ListTagsForResource_RequestSyntax) **   <a name="chimesdk-messaging-chime_ListTagsForResource-request-uri-ResourceARN"></a>
The ARN of the resource.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_messaging-chime_ListTagsForResource_ResponseSyntax) **   <a name="chimesdk-messaging-chime_ListTagsForResource-response-Tags"></a>
The tag key-value pairs.  
Type: Array of [Tag](API_messaging-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/ListTagsForResource) 

# PutChannelExpirationSettings


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

**Note**  
A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.
Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
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.

## Request Syntax


```
PUT /channels/channelArn/expiration-settings HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "ExpirationSettings": { 
      "ExpirationCriterion": "string",
      "ExpirationDays": number
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_PutChannelExpirationSettings_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelExpirationSettings-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_PutChannelExpirationSettings_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelExpirationSettings-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Request Body


The request accepts the following data in JSON format.

 ** [ExpirationSettings](#API_messaging-chime_PutChannelExpirationSettings_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelExpirationSettings-request-ExpirationSettings"></a>
Settings that control the interval after which a channel is deleted.  
Type: [ExpirationSettings](API_messaging-chime_ExpirationSettings.md) object  
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ExpirationSettings": { 
      "ExpirationCriterion": "string",
      "ExpirationDays": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_PutChannelExpirationSettings_ResponseSyntax) **   <a name="chimesdk-messaging-chime_PutChannelExpirationSettings-response-ChannelArn"></a>
The channel ARN.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [ExpirationSettings](#API_messaging-chime_PutChannelExpirationSettings_ResponseSyntax) **   <a name="chimesdk-messaging-chime_PutChannelExpirationSettings-response-ExpirationSettings"></a>
Settings that control the interval after which a channel is deleted.  
Type: [ExpirationSettings](API_messaging-chime_ExpirationSettings.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings) 

# PutChannelMembershipPreferences


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.

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

## Request Syntax


```
PUT /channels/channelArn/memberships/memberArn/preferences HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "Preferences": { 
      "PushNotifications": { 
         "AllowNotifications": "string",
         "FilterRule": "string"
      }
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_PutChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_PutChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [memberArn](#API_messaging-chime_PutChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-request-uri-MemberArn"></a>
The ARN of the member setting the preferences.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [Preferences](#API_messaging-chime_PutChannelMembershipPreferences_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-request-Preferences"></a>
The channel membership preferences of an `AppInstanceUser` .  
Type: [ChannelMembershipPreferences](API_messaging-chime_ChannelMembershipPreferences.md) object  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "Member": { 
      "Arn": "string",
      "Name": "string"
   },
   "Preferences": { 
      "PushNotifications": { 
         "AllowNotifications": "string",
         "FilterRule": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_PutChannelMembershipPreferences_ResponseSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [Member](#API_messaging-chime_PutChannelMembershipPreferences_ResponseSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-response-Member"></a>
The details of a user.  
Type: [Identity](API_messaging-chime_Identity.md) object

 ** [Preferences](#API_messaging-chime_PutChannelMembershipPreferences_ResponseSyntax) **   <a name="chimesdk-messaging-chime_PutChannelMembershipPreferences-response-Preferences"></a>
The ARN and metadata of the member being added.  
Type: [ChannelMembershipPreferences](API_messaging-chime_ChannelMembershipPreferences.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences) 

# PutMessagingStreamingConfigurations


Sets the data streaming configuration for an `AppInstance`. For more information, see [Streaming messaging data](https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the *Amazon Chime SDK Developer Guide*.

## Request Syntax


```
PUT /app-instances/appInstanceArn/streaming-configurations HTTP/1.1
Content-type: application/json

{
   "StreamingConfigurations": [ 
      { 
         "DataType": "string",
         "ResourceArn": "string"
      }
   ]
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [appInstanceArn](#API_messaging-chime_PutMessagingStreamingConfigurations_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutMessagingStreamingConfigurations-request-uri-AppInstanceArn"></a>
The ARN of the streaming configuration.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [StreamingConfigurations](#API_messaging-chime_PutMessagingStreamingConfigurations_RequestSyntax) **   <a name="chimesdk-messaging-chime_PutMessagingStreamingConfigurations-request-StreamingConfigurations"></a>
The streaming configurations.  
Type: Array of [StreamingConfiguration](API_messaging-chime_StreamingConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "StreamingConfigurations": [ 
      { 
         "DataType": "string",
         "ResourceArn": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StreamingConfigurations](#API_messaging-chime_PutMessagingStreamingConfigurations_ResponseSyntax) **   <a name="chimesdk-messaging-chime_PutMessagingStreamingConfigurations-response-StreamingConfigurations"></a>
The requested streaming configurations.  
Type: Array of [StreamingConfiguration](API_messaging-chime_StreamingConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
One or more of the resources in the request does not exist in the system.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations) 

# RedactChannelMessage


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

**Note**  
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.

## Request Syntax


```
POST /channels/channelArn/messages/{messageId}?operation=redact HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "SubChannelId": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_RedactChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-request-uri-ChannelArn"></a>
The ARN of the channel containing the messages that you want to redact.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_RedactChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [messageId](#API_messaging-chime_RedactChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-request-uri-MessageId"></a>
The ID of the message being redacted.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [SubChannelId](#API_messaging-chime_RedactChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-request-SubChannelId"></a>
The ID of the SubChannel in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "MessageId": "string",
   "SubChannelId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_RedactChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-response-ChannelArn"></a>
The ARN of the channel containing the messages that you want to redact.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [MessageId](#API_messaging-chime_RedactChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-response-MessageId"></a>
The ID of the message being redacted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

 ** [SubChannelId](#API_messaging-chime_RedactChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_RedactChannelMessage-response-SubChannelId"></a>
The ID of the SubChannel in the response.  
Only required when redacting messages in a SubChannel that the user belongs to.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/RedactChannelMessage) 

# SearchChannels


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.

**Note**  
This operation isn't supported for `AppInstanceUsers` with a large number of memberships.

## Request Syntax


```
POST /channels?operation=search&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "Fields": [ 
      { 
         "Key": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ChimeBearer](#API_messaging-chime_SearchChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_SearchChannels-request-ChimeBearer"></a>
The `AppInstanceUserArn` of the user making the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [MaxResults](#API_messaging-chime_SearchChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_SearchChannels-request-uri-MaxResults"></a>
The maximum number of channels that you want returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_messaging-chime_SearchChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_SearchChannels-request-uri-NextToken"></a>
The token returned from previous API requests until the number of channels is reached.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Request Body


The request accepts the following data in JSON format.

 ** [Fields](#API_messaging-chime_SearchChannels_RequestSyntax) **   <a name="chimesdk-messaging-chime_SearchChannels-request-Fields"></a>
A list of the `Field` objects in the channel being searched.  
Type: Array of [SearchField](API_messaging-chime_SearchField.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Channels": [ 
      { 
         "ChannelArn": "string",
         "LastMessageTimestamp": number,
         "Metadata": "string",
         "Mode": "string",
         "Name": "string",
         "Privacy": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channels](#API_messaging-chime_SearchChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_SearchChannels-response-Channels"></a>
A list of the channels in the request.  
Type: Array of [ChannelSummary](API_messaging-chime_ChannelSummary.md) objects

 ** [NextToken](#API_messaging-chime_SearchChannels_ResponseSyntax) **   <a name="chimesdk-messaging-chime_SearchChannels-response-NextToken"></a>
The token returned from previous API responses until the number of channels is reached.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/SearchChannels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/SearchChannels) 

# SendChannelMessage


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

**Note**  
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.  
Also, `STANDARD` messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.  
 `CONTROL` messages are limited to 30 bytes and do not contain metadata.

## Request Syntax


```
POST /channels/channelArn/messages HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Content": "string",
   "ContentType": "string",
   "MessageAttributes": { 
      "string" : { 
         "StringValues": [ "string" ]
      }
   },
   "Metadata": "string",
   "Persistence": "string",
   "PushNotification": { 
      "Body": "string",
      "Title": "string",
      "Type": "string"
   },
   "SubChannelId": "string",
   "Target": [ 
      { 
         "MemberArn": "string"
      }
   ],
   "Type": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [ClientRequestToken](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-ClientRequestToken"></a>
The `Idempotency` token for each client request.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 64.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

 ** [Content](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-Content"></a>
The content of the channel message.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[\s\S]*`   
Required: Yes

 ** [ContentType](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-ContentType"></a>
The content type of the channel message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 45.  
Pattern: `[\s\S]*`   
Required: No

 ** [MessageAttributes](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-MessageAttributes"></a>
The attributes for the message, used for message filtering along with a `FilterRule` defined in the `PushNotificationPreferences`.  
Type: String to [MessageAttributeValue](API_messaging-chime_MessageAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `[\s\S]*`   
Required: No

 ** [Metadata](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-Metadata"></a>
The optional metadata for each message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** [Persistence](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-Persistence"></a>
Boolean that controls whether the message is persisted on the back end. Required.  
Type: String  
Valid Values: `PERSISTENT | NON_PERSISTENT`   
Required: Yes

 ** [PushNotification](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-PushNotification"></a>
The push notification configuration of the message.  
Type: [PushNotificationConfiguration](API_messaging-chime_PushNotificationConfiguration.md) object  
Required: No

 ** [SubChannelId](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-SubChannelId"></a>
The ID of the SubChannel in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: No

 ** [Target](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-Target"></a>
The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.   
Type: Array of [Target](API_messaging-chime_Target.md) objects  
Array Members: Fixed number of 1 item.  
Required: No

 ** [Type](#API_messaging-chime_SendChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-request-Type"></a>
The type of message, `STANDARD` or `CONTROL`.  
 `STANDARD` messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.  
 `CONTROL` messages are limited to 30 bytes and do not contain metadata.  
Type: String  
Valid Values: `STANDARD | CONTROL`   
Required: Yes

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "ChannelArn": "string",
   "MessageId": "string",
   "Status": { 
      "Detail": "string",
      "Value": "string"
   },
   "SubChannelId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_SendChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [MessageId](#API_messaging-chime_SendChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-response-MessageId"></a>
The ID string assigned to each message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

 ** [Status](#API_messaging-chime_SendChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-response-Status"></a>
The status of the channel message.  
Type: [ChannelMessageStatusStructure](API_messaging-chime_ChannelMessageStatusStructure.md) object

 ** [SubChannelId](#API_messaging-chime_SendChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_SendChannelMessage-response-SubChannelId"></a>
The ID of the SubChannel in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/SendChannelMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/SendChannelMessage) 

# TagResource


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

## Request Syntax


```
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [ResourceARN](#API_messaging-chime_TagResource_RequestSyntax) **   <a name="chimesdk-messaging-chime_TagResource-request-ResourceARN"></a>
The resource ARN.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [Tags](#API_messaging-chime_TagResource_RequestSyntax) **   <a name="chimesdk-messaging-chime_TagResource-request-Tags"></a>
The tag key-value pairs.  
Type: Array of [Tag](API_messaging-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/TagResource) 

# UntagResource


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

## Request Syntax


```
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [ResourceARN](#API_messaging-chime_UntagResource_RequestSyntax) **   <a name="chimesdk-messaging-chime_UntagResource-request-ResourceARN"></a>
The resource ARN.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [TagKeys](#API_messaging-chime_UntagResource_RequestSyntax) **   <a name="chimesdk-messaging-chime_UntagResource-request-TagKeys"></a>
The tag keys.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Syntax


```
HTTP/1.1 204
```

## Response Elements


If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/UntagResource) 

# UpdateChannel


Update a channel's attributes.

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

**Note**  
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.

## Request Syntax


```
PUT /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "Metadata": "string",
   "Mode": "string",
   "Name": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_UpdateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannel-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_UpdateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannel-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [Metadata](#API_messaging-chime_UpdateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannel-request-Metadata"></a>
The metadata for the update request.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** [Mode](#API_messaging-chime_UpdateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannel-request-Mode"></a>
The mode of the update request.  
Type: String  
Valid Values: `UNRESTRICTED | RESTRICTED`   
Required: No

 ** [Name](#API_messaging-chime_UpdateChannel_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannel-request-Name"></a>
The name of the channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*`   
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_UpdateChannel_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannel-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/UpdateChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/UpdateChannel) 

# UpdateChannelFlow


Updates channel flow attributes. This is a developer API.

## Request Syntax


```
PUT /channel-flows/channelFlowArn HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "Processors": [ 
      { 
         "Configuration": { 
            "Lambda": { 
               "InvocationType": "string",
               "ResourceArn": "string"
            }
         },
         "ExecutionOrder": number,
         "FallbackAction": "string",
         "Name": "string"
      }
   ]
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelFlowArn](#API_messaging-chime_UpdateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelFlow-request-uri-ChannelFlowArn"></a>
The ARN of the channel flow.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [Name](#API_messaging-chime_UpdateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelFlow-request-Name"></a>
The name of the channel flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*`   
Required: Yes

 ** [Processors](#API_messaging-chime_UpdateChannelFlow_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelFlow-request-Processors"></a>
Information about the processor Lambda functions   
Type: Array of [Processor](API_messaging-chime_Processor.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelFlowArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelFlowArn](#API_messaging-chime_UpdateChannelFlow_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelFlow-response-ChannelFlowArn"></a>
The ARN of the channel flow.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/UpdateChannelFlow) 

# UpdateChannelMessage


Updates the content of a message.

**Note**  
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.

## Request Syntax


```
PUT /channels/channelArn/messages/messageId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
   "Content": "string",
   "ContentType": "string",
   "Metadata": "string",
   "SubChannelId": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [messageId](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-uri-MessageId"></a>
The ID string of the message being updated.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [Content](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-Content"></a>
The content of the channel message.   
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[\s\S]*`   
Required: Yes

 ** [ContentType](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-ContentType"></a>
The content type of the channel message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 45.  
Pattern: `[\s\S]*`   
Required: No

 ** [Metadata](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-Metadata"></a>
The metadata of the message being updated.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** [SubChannelId](#API_messaging-chime_UpdateChannelMessage_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-request-SubChannelId"></a>
The ID of the SubChannel in the request.  
Only required when updating messages in a SubChannel that the user belongs to.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*`   
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "MessageId": "string",
   "Status": { 
      "Detail": "string",
      "Value": "string"
   },
   "SubChannelId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_UpdateChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [MessageId](#API_messaging-chime_UpdateChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-response-MessageId"></a>
The ID string of the message being updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

 ** [Status](#API_messaging-chime_UpdateChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-response-Status"></a>
The status of the message update.  
Type: [ChannelMessageStatusStructure](API_messaging-chime_ChannelMessageStatusStructure.md) object

 ** [SubChannelId](#API_messaging-chime_UpdateChannelMessage_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelMessage-response-SubChannelId"></a>
The ID of the SubChannel in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-_a-zA-Z0-9]*` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/UpdateChannelMessage) 

# UpdateChannelReadMarker


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

**Note**  
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.

## Request Syntax


```
PUT /channels/channelArn/readMarker HTTP/1.1
x-amz-chime-bearer: ChimeBearer
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [channelArn](#API_messaging-chime_UpdateChannelReadMarker_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelReadMarker-request-uri-ChannelArn"></a>
The ARN of the channel.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [ChimeBearer](#API_messaging-chime_UpdateChannelReadMarker_RequestSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelReadMarker-request-ChimeBearer"></a>
The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API call.  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_messaging-chime_UpdateChannelReadMarker_ResponseSyntax) **   <a name="chimesdk-messaging-chime_UpdateChannelReadMarker-response-ChannelArn"></a>
The ARN of the channel.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 1600.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The client exceeded its request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client is not currently authorized to make the request.  
HTTP Status Code: 401

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker)