|
1536 | 1536 | "name": "chime" |
1537 | 1537 | }, |
1538 | 1538 | "aws.protocols#restJson1": {}, |
1539 | | - "smithy.api#documentation": "<p>The Amazon Chime SDK messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK identity APIs. For more information about the messaging\n APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html\">Amazon Chime SDK messaging</a>.</p>", |
| 1539 | + "smithy.api#documentation": "<p>The Amazon Chime SDK messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK identity APIs. For more information about the messaging\n APIs, see <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html\">Amazon Chime SDK messaging</a>.</p>", |
1540 | 1540 | "smithy.api#title": "Amazon Chime SDK Messaging", |
1541 | 1541 | "smithy.rules#endpointRuleSet": { |
1542 | 1542 | "version": "1.0", |
|
2358 | 2358 | } |
2359 | 2359 | ], |
2360 | 2360 | "traits": { |
2361 | | - "smithy.api#documentation": "<p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.</p>\n <p>Channel flows process the following items:</p>\n <ol>\n <li>\n <p>New and updated messages</p>\n </li>\n <li>\n <p>Persistent and non-persistent messages</p>\n </li>\n <li>\n <p>The Standard message type</p>\n </li>\n </ol>\n <note>\n <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to \n <a href=\"https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types\">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>\n </note>", |
| 2361 | + "smithy.api#documentation": "<p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.</p>\n <p>Channel flows process the following items:</p>\n <ol>\n <li>\n <p>New and updated messages</p>\n </li>\n <li>\n <p>Persistent and non-persistent messages</p>\n </li>\n <li>\n <p>The Standard message type</p>\n </li>\n </ol>\n <note>\n <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to \n <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/dg/using-the-messaging-sdk.html#msg-types\">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>\n </note>", |
2362 | 2362 | "smithy.api#http": { |
2363 | 2363 | "method": "POST", |
2364 | 2364 | "uri": "/channel-flows", |
|
2693 | 2693 | "ChannelId": { |
2694 | 2694 | "target": "com.amazonaws.chimesdkmessaging#ChannelId", |
2695 | 2695 | "traits": { |
2696 | | - "smithy.api#documentation": "<p>The ID of the channel in the request.</p>" |
| 2696 | + "smithy.api#documentation": "<p>An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.</p>" |
2697 | 2697 | } |
2698 | 2698 | }, |
2699 | 2699 | "MemberArns": { |
|
4382 | 4382 | }, |
4383 | 4383 | "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointRequest": { |
4384 | 4384 | "type": "structure", |
4385 | | - "members": {}, |
| 4385 | + "members": { |
| 4386 | + "NetworkType": { |
| 4387 | + "target": "com.amazonaws.chimesdkmessaging#NetworkType", |
| 4388 | + "traits": { |
| 4389 | + "smithy.api#documentation": "<p>The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).</p>", |
| 4390 | + "smithy.api#httpQuery": "network-type" |
| 4391 | + } |
| 4392 | + } |
| 4393 | + }, |
4386 | 4394 | "traits": { |
4387 | 4395 | "smithy.api#input": {} |
4388 | 4396 | } |
|
4761 | 4769 | } |
4762 | 4770 | ], |
4763 | 4771 | "traits": { |
4764 | | - "smithy.api#documentation": "<p>Lists all channel memberships in a channel.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in\n the header.</p>\n </note>\n <p>If you want to list the channels to which a specific app instance user belongs, see the \n <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html\">ListChannelMembershipsForAppInstanceUser</a> API.</p>", |
| 4772 | + "smithy.api#documentation": "<p>Lists all channel memberships in a channel.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in\n the header.</p>\n </note>\n <p>If you want to list the channels to which a specific app instance user belongs, see the \n <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html\">ListChannelMembershipsForAppInstanceUser</a> API.</p>", |
4765 | 4773 | "smithy.api#http": { |
4766 | 4774 | "method": "GET", |
4767 | 4775 | "uri": "/channels/{ChannelArn}/memberships", |
|
5818 | 5826 | } |
5819 | 5827 | } |
5820 | 5828 | }, |
| 5829 | + "com.amazonaws.chimesdkmessaging#NetworkType": { |
| 5830 | + "type": "enum", |
| 5831 | + "members": { |
| 5832 | + "IPV4_ONLY": { |
| 5833 | + "target": "smithy.api#Unit", |
| 5834 | + "traits": { |
| 5835 | + "smithy.api#enumValue": "IPV4_ONLY" |
| 5836 | + } |
| 5837 | + }, |
| 5838 | + "DUAL_STACK": { |
| 5839 | + "target": "smithy.api#Unit", |
| 5840 | + "traits": { |
| 5841 | + "smithy.api#enumValue": "DUAL_STACK" |
| 5842 | + } |
| 5843 | + } |
| 5844 | + } |
| 5845 | + }, |
5821 | 5846 | "com.amazonaws.chimesdkmessaging#NextToken": { |
5822 | 5847 | "type": "string", |
5823 | 5848 | "traits": { |
|
6327 | 6352 | } |
6328 | 6353 | ], |
6329 | 6354 | "traits": { |
6330 | | - "smithy.api#documentation": "<p>Redacts message content, but not metadata. The message exists in the back end, but the\n action returns null content, and the state shows as redacted.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in\n the header.</p>\n </note>", |
| 6355 | + "smithy.api#documentation": "<p>Redacts message content and metadata. The message exists in the back end, but the\n action returns null content, and the state shows as redacted.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in\n the header.</p>\n </note>", |
6331 | 6356 | "smithy.api#http": { |
6332 | 6357 | "method": "POST", |
6333 | 6358 | "uri": "/channels/{ChannelArn}/messages/{MessageId}?operation=redact", |
|
6455 | 6480 | } |
6456 | 6481 | ], |
6457 | 6482 | "traits": { |
6458 | | - "smithy.api#documentation": "<p>Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search \n across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across \n all channels.</p>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in\n the header.</p>", |
| 6483 | + "smithy.api#documentation": "<p>Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search \n across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across \n all channels.</p>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in\n the header.</p>\n <note>\n <p>This operation isn't supported for <code>AppInstanceUsers</code> with a large number of memberships.</p>\n </note>", |
6459 | 6484 | "smithy.api#http": { |
6460 | 6485 | "method": "POST", |
6461 | 6486 | "uri": "/channels?operation=search", |
|
6537 | 6562 | "Values": { |
6538 | 6563 | "target": "com.amazonaws.chimesdkmessaging#SearchFieldValues", |
6539 | 6564 | "traits": { |
6540 | | - "smithy.api#documentation": "<p>The values that you want to search for, a list of strings. The values must be <code>AppInstanceUserArns</code> specified as a list of strings.</p>\n <note>\n <p>This operation isn't supported for <code>AppInstanceUsers</code> with large number of memberships.</p>\n </note>", |
| 6565 | + "smithy.api#documentation": "<p>The values that you want to search for, a list of strings. The values must be <code>AppInstanceUserArns</code> specified as a list of strings.</p>\n <note>\n <p>This operation isn't supported for <code>AppInstanceUsers</code> with a large number of memberships.</p>\n </note>", |
6541 | 6566 | "smithy.api#required": {} |
6542 | 6567 | } |
6543 | 6568 | }, |
|
6550 | 6575 | } |
6551 | 6576 | }, |
6552 | 6577 | "traits": { |
6553 | | - "smithy.api#documentation": "<p>A <code>Field</code> of the channel that you want to search.</p>" |
| 6578 | + "smithy.api#documentation": "<p>A <code>Field</code> of the channel that you want to search.</p>\n <note>\n <p>This operation isn't supported for <code>AppInstanceUsers</code> with a large number of memberships.</p>\n </note>" |
6554 | 6579 | } |
6555 | 6580 | }, |
6556 | 6581 | "com.amazonaws.chimesdkmessaging#SearchFieldKey": { |
|
0 commit comments