*
* The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom * messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more * information about the messaging APIs, see Amazon * Chime SDK messaging. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeSDKMessagingClient extends AmazonWebServiceClient implements AmazonChimeSDKMessaging { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonChimeSDKMessaging.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "chime"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("UnauthorizedClientException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.UnauthorizedClientExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("NotFoundException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.NotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceFailureException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.ServiceFailureExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.ConflictExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottledClientException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.ThrottledClientExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceUnavailableException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.ServiceUnavailableExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ForbiddenException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.ForbiddenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceLimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.ResourceLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("BadRequestException").withExceptionUnmarshaller( com.amazonaws.services.chimesdkmessaging.model.transform.BadRequestExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.chimesdkmessaging.model.AmazonChimeSDKMessagingException.class)); public static AmazonChimeSDKMessagingClientBuilder builder() { return AmazonChimeSDKMessagingClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on Amazon Chime SDK Messaging using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonChimeSDKMessagingClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on Amazon Chime SDK Messaging using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonChimeSDKMessagingClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("messaging-chime.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/chimesdkmessaging/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/chimesdkmessaging/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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.
*
* 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.
*
* Adds a specified number of users and bots to a channel. *
* * @param batchCreateChannelMembershipRequest * @return Result of the BatchCreateChannelMembership operation returned by the service. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @sample AmazonChimeSDKMessaging.BatchCreateChannelMembership * @see AWS API Documentation */ @Override public BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request) { request = beforeClientExecution(request); return executeBatchCreateChannelMembership(request); } @SdkInternalApi final BatchCreateChannelMembershipResult executeBatchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) { ExecutionContext executionContext = createExecutionContext(batchCreateChannelMembershipRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 *
** Creates a channel to which you can add users and send messages. *
** Restriction: You can't change a channel's privacy. *
*
* 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.
*
* 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. *
*
* 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.
*
* 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: *
** New and updated messages *
** Persistent and non-persistent messages *
** The Standard message type *
** 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 in * the Amazon Chime developer guide. *
*
* 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. *
*
* 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.
*
* 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. *
*
* The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBotof the user that makes the API call as the value in the header.
*
* Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible * process. *
*
* 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.
*
* Removes a member from a channel's ban list. *
*
* 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.
*
* Deletes a channel flow, an irreversible process. This is a developer API. *
*
* 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.
*
* Removes a member from a channel. *
*
* 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.
*
* Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
* A background process deletes any revisions created by UpdateChannelMessage.
*
* 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.
*
* Deletes a channel moderator. *
*
* 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.
*
* Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
* Returns the full details of a channel in an Amazon Chime AppInstance.
*
* 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.
*
* Returns the full details of a channel ban. *
*
* 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.
*
* Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
*
* Returns the full details of a user's channel membership. *
*
* 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.
*
* Returns the details of a channel based on the membership of the specified AppInstanceUser or
* AppInstanceBot.
*
* 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.
*
* Returns the full details of a channel moderated by the specified AppInstanceUser or
* AppInstanceBot.
*
* 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.
*
* Returns the full details of a single ChannelModerator. *
*
* 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.
*
* Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going * through the channel flow processor. *
** 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.
*
* 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.
*
* 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.
*
* Gets the full details of a channel message. *
*
* 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.
*
* 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. *
** Message processed successfully *
** Ongoing processing *
** Processing failed *
** Message denied by the processor *
** 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.
*
* The details of the endpoint for the messaging session. *
* * @param getMessagingSessionEndpointRequest * @return Result of the GetMessagingSessionEndpoint operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.GetMessagingSessionEndpoint * @see AWS API Documentation */ @Override public GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request) { request = beforeClientExecution(request); return executeGetMessagingSessionEndpoint(request); } @SdkInternalApi final GetMessagingSessionEndpointResult executeGetMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) { ExecutionContext executionContext = createExecutionContext(getMessagingSessionEndpointRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
* Lists all the users and bots banned from a particular channel. *
*
* 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.
*
* Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API. *
* * @param listChannelFlowsRequest * @return Result of the ListChannelFlows operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.ListChannelFlows * @see AWS API Documentation */ @Override public ListChannelFlowsResult listChannelFlows(ListChannelFlowsRequest request) { request = beforeClientExecution(request); return executeListChannelFlows(request); } @SdkInternalApi final ListChannelFlowsResult executeListChannelFlows(ListChannelFlowsRequest listChannelFlowsRequest) { ExecutionContext executionContext = createExecutionContext(listChannelFlowsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists all channel memberships in a channel. *
*
* 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 API. *
* * @param listChannelMembershipsRequest * @return Result of the ListChannelMemberships operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.ListChannelMemberships * @see AWS API Documentation */ @Override public ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request) { request = beforeClientExecution(request); return executeListChannelMemberships(request); } @SdkInternalApi final ListChannelMembershipsResult executeListChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest) { ExecutionContext executionContext = createExecutionContext(listChannelMembershipsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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.
*
* 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.
*
* List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
* by creation timestamp in descending order.
*
* 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.
*
* Lists all the moderators for a channel. *
*
* 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.
*
* 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.
*
* 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.
*
* 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. *
* * @param listChannelsAssociatedWithChannelFlowRequest * @return Result of the ListChannelsAssociatedWithChannelFlow operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.ListChannelsAssociatedWithChannelFlow * @see AWS API Documentation */ @Override public ListChannelsAssociatedWithChannelFlowResult listChannelsAssociatedWithChannelFlow(ListChannelsAssociatedWithChannelFlowRequest request) { request = beforeClientExecution(request); return executeListChannelsAssociatedWithChannelFlow(request); } @SdkInternalApi final ListChannelsAssociatedWithChannelFlowResult executeListChannelsAssociatedWithChannelFlow( ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) { ExecutionContext executionContext = createExecutionContext(listChannelsAssociatedWithChannelFlowRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* A list of the channels moderated by an AppInstanceUser.
*
* 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.
*
* 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. *
* * @param listSubChannelsRequest * @return Result of the ListSubChannels operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.ListSubChannels * @see AWS API Documentation */ @Override public ListSubChannelsResult listSubChannels(ListSubChannelsRequest request) { request = beforeClientExecution(request); return executeListSubChannels(request); } @SdkInternalApi final ListSubChannelsResult executeListSubChannels(ListSubChannelsRequest listSubChannelsRequest) { ExecutionContext executionContext = createExecutionContext(listSubChannelsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists the tags applied to an Amazon Chime SDK messaging resource. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.ListTagsForResource * @see AWS API Documentation */ @Override public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) { request = beforeClientExecution(request); return executeListTagsForResource(request); } @SdkInternalApi final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) { ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Sets the number of days before the channel is automatically deleted. *
** 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.
*
* 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.
*
* 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.
*
* Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
* Redacts message content, but not metadata. The message exists in the back end, but the action returns null * content, and the state shows as redacted. *
*
* 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.
*
* 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.
*
* Sends a message to a particular channel that the member is a part of. *
*
* 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.
*
* Applies the specified tags to the specified Amazon Chime SDK messaging resource. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.TagResource * @see AWS API Documentation */ @Override public TagResourceResult tagResource(TagResourceRequest request) { request = beforeClientExecution(request); return executeTagResource(request); } @SdkInternalApi final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) { ExecutionContext executionContext = createExecutionContext(tagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Removes the specified tags from the specified Amazon Chime SDK messaging resource. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.UntagResource * @see AWS API Documentation */ @Override public UntagResourceResult untagResource(UntagResourceRequest request) { request = beforeClientExecution(request); return executeUntagResource(request); } @SdkInternalApi final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) { ExecutionContext executionContext = createExecutionContext(untagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Update a channel's attributes. *
** Restriction: You can't change a channel's privacy. *
*
* 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.
*
* Updates channel flow attributes. This is a developer API. *
* * @param updateChannelFlowRequest * @return Result of the UpdateChannelFlow operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChimeSDKMessaging.UpdateChannelFlow * @see AWS API Documentation */ @Override public UpdateChannelFlowResult updateChannelFlow(UpdateChannelFlowRequest request) { request = beforeClientExecution(request); return executeUpdateChannelFlow(request); } @SdkInternalApi final UpdateChannelFlowResult executeUpdateChannelFlow(UpdateChannelFlowRequest updateChannelFlowRequest) { ExecutionContext executionContext = createExecutionContext(updateChannelFlowRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Updates the content of a message. *
*
* 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.
*
* The details of the time when a user last read messages in a channel. *
*
* 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.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private