1065 lines
40 KiB
JSON
1065 lines
40 KiB
JSON
{
|
||
"version":"2.0",
|
||
"metadata":{
|
||
"apiVersion":"2020-07-14",
|
||
"endpointPrefix":"ivschat",
|
||
"jsonVersion":"1.1",
|
||
"protocol":"rest-json",
|
||
"serviceAbbreviation":"ivschat",
|
||
"serviceFullName":"Amazon Interactive Video Service Chat",
|
||
"serviceId":"ivschat",
|
||
"signatureVersion":"v4",
|
||
"signingName":"ivschat",
|
||
"uid":"ivschat-2020-07-14"
|
||
},
|
||
"operations":{
|
||
"CreateChatToken":{
|
||
"name":"CreateChatToken",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/CreateChatToken",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"CreateChatTokenRequest"},
|
||
"output":{"shape":"CreateChatTokenResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"PendingVerification"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.</p> <p>Encryption keys are owned by Amazon IVS Chat and never used directly by your application.</p>"
|
||
},
|
||
"CreateRoom":{
|
||
"name":"CreateRoom",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/CreateRoom",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"CreateRoomRequest"},
|
||
"output":{"shape":"CreateRoomResponse"},
|
||
"errors":[
|
||
{"shape":"ConflictException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ServiceQuotaExceededException"},
|
||
{"shape":"PendingVerification"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Creates a room that allows clients to connect and pass messages.</p>"
|
||
},
|
||
"DeleteMessage":{
|
||
"name":"DeleteMessage",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/DeleteMessage",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DeleteMessageRequest"},
|
||
"output":{"shape":"DeleteMessageResponse"},
|
||
"errors":[
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html\"> DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>"
|
||
},
|
||
"DeleteRoom":{
|
||
"name":"DeleteRoom",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/DeleteRoom",
|
||
"responseCode":204
|
||
},
|
||
"input":{"shape":"DeleteRoomRequest"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"PendingVerification"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Deletes the specified room.</p>"
|
||
},
|
||
"DisconnectUser":{
|
||
"name":"DisconnectUser",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/DisconnectUser",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DisconnectUserRequest"},
|
||
"output":{"shape":"DisconnectUserResponse"},
|
||
"errors":[
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Disconnects all connections using a specified user ID from a room. This replicates the <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html\"> DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>"
|
||
},
|
||
"GetRoom":{
|
||
"name":"GetRoom",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/GetRoom",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"GetRoomRequest"},
|
||
"output":{"shape":"GetRoomResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Gets the specified room.</p>"
|
||
},
|
||
"ListRooms":{
|
||
"name":"ListRooms",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/ListRooms",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListRoomsRequest"},
|
||
"output":{"shape":"ListRoomsResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of <code>updateTime</code>.</p>"
|
||
},
|
||
"ListTagsForResource":{
|
||
"name":"ListTagsForResource",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/tags/{resourceArn}",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListTagsForResourceRequest"},
|
||
"output":{"shape":"ListTagsForResourceResponse"},
|
||
"errors":[
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Gets information about AWS tags for the specified ARN.</p>"
|
||
},
|
||
"SendEvent":{
|
||
"name":"SendEvent",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/SendEvent",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"SendEventRequest"},
|
||
"output":{"shape":"SendEventResponse"},
|
||
"errors":[
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.</p>"
|
||
},
|
||
"TagResource":{
|
||
"name":"TagResource",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/tags/{resourceArn}",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"TagResourceRequest"},
|
||
"output":{"shape":"TagResourceResponse"},
|
||
"errors":[
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Adds or updates tags for the AWS resource with the specified ARN.</p>"
|
||
},
|
||
"UntagResource":{
|
||
"name":"UntagResource",
|
||
"http":{
|
||
"method":"DELETE",
|
||
"requestUri":"/tags/{resourceArn}",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"UntagResourceRequest"},
|
||
"output":{"shape":"UntagResourceResponse"},
|
||
"errors":[
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Removes tags from the resource with the specified ARN.</p>",
|
||
"idempotent":true
|
||
},
|
||
"UpdateRoom":{
|
||
"name":"UpdateRoom",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/UpdateRoom",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"UpdateRoomRequest"},
|
||
"output":{"shape":"UpdateRoomResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"PendingVerification"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Updates a room’s configuration.</p>"
|
||
}
|
||
},
|
||
"shapes":{
|
||
"AccessDeniedException":{
|
||
"type":"structure",
|
||
"required":["message"],
|
||
"members":{
|
||
"message":{"shape":"ErrorMessage"}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":403,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"ChatToken":{"type":"string"},
|
||
"ChatTokenAttributes":{
|
||
"type":"map",
|
||
"key":{"shape":"String"},
|
||
"value":{"shape":"String"}
|
||
},
|
||
"ChatTokenCapabilities":{
|
||
"type":"list",
|
||
"member":{"shape":"ChatTokenCapability"}
|
||
},
|
||
"ChatTokenCapability":{
|
||
"type":"string",
|
||
"enum":[
|
||
"SEND_MESSAGE",
|
||
"DISCONNECT_USER",
|
||
"DELETE_MESSAGE"
|
||
]
|
||
},
|
||
"ConflictException":{
|
||
"type":"structure",
|
||
"required":[
|
||
"message",
|
||
"resourceId",
|
||
"resourceType"
|
||
],
|
||
"members":{
|
||
"message":{"shape":"ErrorMessage"},
|
||
"resourceId":{
|
||
"shape":"ResourceId",
|
||
"documentation":"<p/>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"ResourceType",
|
||
"documentation":"<p/>"
|
||
}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":409,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"CreateChatTokenRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"roomIdentifier",
|
||
"userId"
|
||
],
|
||
"members":{
|
||
"attributes":{
|
||
"shape":"ChatTokenAttributes",
|
||
"documentation":"<p>Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.</p>"
|
||
},
|
||
"capabilities":{
|
||
"shape":"ChatTokenCapabilities",
|
||
"documentation":"<p>Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).</p>"
|
||
},
|
||
"roomIdentifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room that the client is trying to access. Currently this must be an ARN. </p>"
|
||
},
|
||
"sessionDurationInMinutes":{
|
||
"shape":"SessionDurationInMinutes",
|
||
"documentation":"<p>Session duration (in minutes), after which the session expires. Default: 60 (1 hour).</p>"
|
||
},
|
||
"userId":{
|
||
"shape":"UserID",
|
||
"documentation":"<p>Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateChatTokenResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"sessionExpirationTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
},
|
||
"token":{
|
||
"shape":"ChatToken",
|
||
"documentation":"<p>The issued client token, encrypted.</p>"
|
||
},
|
||
"tokenExpirationTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateRoomRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"maximumMessageLength":{
|
||
"shape":"RoomMaxMessageLength",
|
||
"documentation":"<p>Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.</p>"
|
||
},
|
||
"maximumMessageRatePerSecond":{
|
||
"shape":"RoomMaxMessageRatePerSecond",
|
||
"documentation":"<p>Maximum number of messages per second that can be sent to the room (by all clients). Default: 10. </p>"
|
||
},
|
||
"messageReviewHandler":{
|
||
"shape":"MessageReviewHandler",
|
||
"documentation":"<p>Configuration information for optional review of messages.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Room name. The value does not need to be unique.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Tags to attach to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. </p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateRoomResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"arn":{
|
||
"shape":"RoomArn",
|
||
"documentation":"<p>Room ARN, assigned by the system.</p>"
|
||
},
|
||
"createTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
},
|
||
"id":{
|
||
"shape":"RoomID",
|
||
"documentation":"<p>Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.</p>"
|
||
},
|
||
"maximumMessageLength":{
|
||
"shape":"RoomMaxMessageLength",
|
||
"documentation":"<p>Maximum number of characters in a single message, from the request.</p>"
|
||
},
|
||
"maximumMessageRatePerSecond":{
|
||
"shape":"RoomMaxMessageRatePerSecond",
|
||
"documentation":"<p>Maximum number of messages per second that can be sent to the room (by all clients), from the request.</p>"
|
||
},
|
||
"messageReviewHandler":{
|
||
"shape":"MessageReviewHandler",
|
||
"documentation":"<p>Configuration information for optional review of messages.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Room name, from the request (if specified).</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Tags attached to the resource, from the request.</p>"
|
||
},
|
||
"updateTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteMessageRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"id",
|
||
"roomIdentifier"
|
||
],
|
||
"members":{
|
||
"id":{
|
||
"shape":"MessageID",
|
||
"documentation":"<p>ID of the message to be deleted. This is the <code>Id</code> field in the received message (see <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html\"> Message (Subscribe)</a> in the Chat Messaging API).</p>"
|
||
},
|
||
"reason":{
|
||
"shape":"Reason",
|
||
"documentation":"<p>Reason for deleting the message.</p>"
|
||
},
|
||
"roomIdentifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room where the message should be deleted. Currently this must be an ARN. </p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteMessageResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"id":{
|
||
"shape":"ID",
|
||
"documentation":"<p>Operation identifier, generated by Amazon IVS Chat.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteRoomRequest":{
|
||
"type":"structure",
|
||
"required":["identifier"],
|
||
"members":{
|
||
"identifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room to be deleted. Currently this must be an ARN.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DisconnectUserRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"roomIdentifier",
|
||
"userId"
|
||
],
|
||
"members":{
|
||
"reason":{
|
||
"shape":"Reason",
|
||
"documentation":"<p>Reason for disconnecting the user.</p>"
|
||
},
|
||
"roomIdentifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.</p>"
|
||
},
|
||
"userId":{
|
||
"shape":"UserID",
|
||
"documentation":"<p>ID of the user (connection) to disconnect from the room.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DisconnectUserResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"ErrorMessage":{"type":"string"},
|
||
"EventAttributes":{
|
||
"type":"map",
|
||
"key":{"shape":"String"},
|
||
"value":{"shape":"String"}
|
||
},
|
||
"EventName":{
|
||
"type":"string",
|
||
"max":100,
|
||
"min":1
|
||
},
|
||
"FallbackResult":{
|
||
"type":"string",
|
||
"enum":[
|
||
"ALLOW",
|
||
"DENY"
|
||
]
|
||
},
|
||
"FieldName":{"type":"string"},
|
||
"GetRoomRequest":{
|
||
"type":"structure",
|
||
"required":["identifier"],
|
||
"members":{
|
||
"identifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.</p>"
|
||
}
|
||
}
|
||
},
|
||
"GetRoomResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"arn":{
|
||
"shape":"RoomArn",
|
||
"documentation":"<p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>"
|
||
},
|
||
"createTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
},
|
||
"id":{
|
||
"shape":"RoomID",
|
||
"documentation":"<p>Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.</p>"
|
||
},
|
||
"maximumMessageLength":{
|
||
"shape":"RoomMaxMessageLength",
|
||
"documentation":"<p>Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.</p>"
|
||
},
|
||
"maximumMessageRatePerSecond":{
|
||
"shape":"RoomMaxMessageRatePerSecond",
|
||
"documentation":"<p>Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.</p>"
|
||
},
|
||
"messageReviewHandler":{
|
||
"shape":"MessageReviewHandler",
|
||
"documentation":"<p>Configuration information for optional review of messages.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Room name. The value does not need to be unique.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>.</p>"
|
||
},
|
||
"updateTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ID":{
|
||
"type":"string",
|
||
"max":12,
|
||
"min":12,
|
||
"pattern":"^[a-zA-Z0-9]+$"
|
||
},
|
||
"InternalServerException":{
|
||
"type":"structure",
|
||
"required":["message"],
|
||
"members":{
|
||
"message":{"shape":"ErrorMessage"}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{"httpStatusCode":500},
|
||
"exception":true,
|
||
"fault":true
|
||
},
|
||
"LambdaArn":{
|
||
"type":"string",
|
||
"max":170,
|
||
"min":0,
|
||
"pattern":"^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+"
|
||
},
|
||
"Limit":{"type":"integer"},
|
||
"ListRoomsRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"maxResults":{
|
||
"shape":"MaxRoomResults",
|
||
"documentation":"<p>Maximum number of rooms to return. Default: 50.</p>"
|
||
},
|
||
"messageReviewHandlerUri":{
|
||
"shape":"LambdaArn",
|
||
"documentation":"<p>Filters the list to match the specified message review handler URI.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Filters the list to match the specified room name.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"PaginationToken",
|
||
"documentation":"<p>The first room to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListRoomsResponse":{
|
||
"type":"structure",
|
||
"required":["rooms"],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"PaginationToken",
|
||
"documentation":"<p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>"
|
||
},
|
||
"rooms":{
|
||
"shape":"RoomList",
|
||
"documentation":"<p>List of the matching rooms (summary information only).</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListTagsForResourceRequest":{
|
||
"type":"structure",
|
||
"required":["resourceArn"],
|
||
"members":{
|
||
"resourceArn":{
|
||
"shape":"ResourceArn",
|
||
"documentation":"<p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>",
|
||
"location":"uri",
|
||
"locationName":"resourceArn"
|
||
}
|
||
}
|
||
},
|
||
"ListTagsForResourceResponse":{
|
||
"type":"structure",
|
||
"required":["tags"],
|
||
"members":{
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Tags to attach to the resource. Array of maps, each of the form <code>string:string (key:value)</code>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"MaxRoomResults":{
|
||
"type":"integer",
|
||
"max":50,
|
||
"min":1
|
||
},
|
||
"MessageID":{
|
||
"type":"string",
|
||
"max":12,
|
||
"min":12,
|
||
"pattern":"^[a-zA-Z0-9]+$"
|
||
},
|
||
"MessageReviewHandler":{
|
||
"type":"structure",
|
||
"members":{
|
||
"fallbackResult":{
|
||
"shape":"FallbackResult",
|
||
"documentation":"<p>Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html\"> Service Quotas</a>.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: <code>ALLOW</code>.</p>"
|
||
},
|
||
"uri":{
|
||
"shape":"LambdaArn",
|
||
"documentation":"<p>Identifier of the message review handler. Currently this must be an ARN of a lambda function.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Configuration information for optional message review.</p>"
|
||
},
|
||
"PaginationToken":{
|
||
"type":"string",
|
||
"max":1024,
|
||
"min":0
|
||
},
|
||
"PendingVerification":{
|
||
"type":"structure",
|
||
"required":["message"],
|
||
"members":{
|
||
"message":{"shape":"ErrorMessage"}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":403,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"Reason":{
|
||
"type":"string",
|
||
"max":256,
|
||
"min":1
|
||
},
|
||
"ResourceArn":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1,
|
||
"pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$"
|
||
},
|
||
"ResourceId":{
|
||
"type":"string",
|
||
"pattern":"^[a-zA-Z0-9]+$"
|
||
},
|
||
"ResourceNotFoundException":{
|
||
"type":"structure",
|
||
"required":[
|
||
"message",
|
||
"resourceId",
|
||
"resourceType"
|
||
],
|
||
"members":{
|
||
"message":{"shape":"ErrorMessage"},
|
||
"resourceId":{
|
||
"shape":"ResourceId",
|
||
"documentation":"<p/>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"ResourceType",
|
||
"documentation":"<p/>"
|
||
}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":404,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"ResourceType":{
|
||
"type":"string",
|
||
"enum":["ROOM"]
|
||
},
|
||
"RoomArn":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1,
|
||
"pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$"
|
||
},
|
||
"RoomID":{
|
||
"type":"string",
|
||
"max":12,
|
||
"min":12,
|
||
"pattern":"^[a-zA-Z0-9]+$"
|
||
},
|
||
"RoomIdentifier":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1,
|
||
"pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$"
|
||
},
|
||
"RoomList":{
|
||
"type":"list",
|
||
"member":{"shape":"RoomSummary"}
|
||
},
|
||
"RoomMaxMessageLength":{
|
||
"type":"integer",
|
||
"max":500,
|
||
"min":1
|
||
},
|
||
"RoomMaxMessageRatePerSecond":{
|
||
"type":"integer",
|
||
"max":10,
|
||
"min":1
|
||
},
|
||
"RoomName":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":0,
|
||
"pattern":"^[a-zA-Z0-9-_]*$"
|
||
},
|
||
"RoomSummary":{
|
||
"type":"structure",
|
||
"members":{
|
||
"arn":{
|
||
"shape":"RoomArn",
|
||
"documentation":"<p>Room ARN.</p>"
|
||
},
|
||
"createTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>. </p>"
|
||
},
|
||
"id":{
|
||
"shape":"RoomID",
|
||
"documentation":"<p>Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.</p>"
|
||
},
|
||
"messageReviewHandler":{
|
||
"shape":"MessageReviewHandler",
|
||
"documentation":"<p>Configuration information for optional review of messages.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Room name. The value does not need to be unique.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Tags attached to the resource. </p>"
|
||
},
|
||
"updateTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Summary information about a room.</p>"
|
||
},
|
||
"SendEventRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"eventName",
|
||
"roomIdentifier"
|
||
],
|
||
"members":{
|
||
"attributes":{
|
||
"shape":"EventAttributes",
|
||
"documentation":"<p>Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.</p>"
|
||
},
|
||
"eventName":{
|
||
"shape":"EventName",
|
||
"documentation":"<p>Application-defined name of the event to send to clients.</p>"
|
||
},
|
||
"roomIdentifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room to which the event will be sent. Currently this must be an ARN.</p>"
|
||
}
|
||
}
|
||
},
|
||
"SendEventResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"id":{
|
||
"shape":"ID",
|
||
"documentation":"<p>An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ServiceQuotaExceededException":{
|
||
"type":"structure",
|
||
"required":[
|
||
"limit",
|
||
"message",
|
||
"resourceId",
|
||
"resourceType"
|
||
],
|
||
"members":{
|
||
"limit":{
|
||
"shape":"Limit",
|
||
"documentation":"<p/>"
|
||
},
|
||
"message":{"shape":"ErrorMessage"},
|
||
"resourceId":{
|
||
"shape":"ResourceId",
|
||
"documentation":"<p/>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"ResourceType",
|
||
"documentation":"<p/>"
|
||
}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":402,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"SessionDurationInMinutes":{
|
||
"type":"integer",
|
||
"max":180,
|
||
"min":1
|
||
},
|
||
"String":{"type":"string"},
|
||
"TagKey":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1
|
||
},
|
||
"TagKeyList":{
|
||
"type":"list",
|
||
"member":{"shape":"TagKey"},
|
||
"max":50,
|
||
"min":0
|
||
},
|
||
"TagResourceRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"resourceArn",
|
||
"tags"
|
||
],
|
||
"members":{
|
||
"resourceArn":{
|
||
"shape":"ResourceArn",
|
||
"documentation":"<p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>",
|
||
"location":"uri",
|
||
"locationName":"resourceArn"
|
||
},
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Array of tags to be added or updated.</p>"
|
||
}
|
||
}
|
||
},
|
||
"TagResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"TagValue":{
|
||
"type":"string",
|
||
"max":256,
|
||
"min":0
|
||
},
|
||
"Tags":{
|
||
"type":"map",
|
||
"key":{"shape":"TagKey"},
|
||
"value":{"shape":"TagValue"},
|
||
"max":50,
|
||
"min":0
|
||
},
|
||
"ThrottlingException":{
|
||
"type":"structure",
|
||
"required":[
|
||
"limit",
|
||
"message",
|
||
"resourceId",
|
||
"resourceType"
|
||
],
|
||
"members":{
|
||
"limit":{
|
||
"shape":"Limit",
|
||
"documentation":"<p/>"
|
||
},
|
||
"message":{"shape":"ErrorMessage"},
|
||
"resourceId":{
|
||
"shape":"ResourceId",
|
||
"documentation":"<p/>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"ResourceType",
|
||
"documentation":"<p/>"
|
||
}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":429,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"Time":{
|
||
"type":"timestamp",
|
||
"timestampFormat":"iso8601"
|
||
},
|
||
"UntagResourceRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"resourceArn",
|
||
"tagKeys"
|
||
],
|
||
"members":{
|
||
"resourceArn":{
|
||
"shape":"ResourceArn",
|
||
"documentation":"<p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>",
|
||
"location":"uri",
|
||
"locationName":"resourceArn"
|
||
},
|
||
"tagKeys":{
|
||
"shape":"TagKeyList",
|
||
"documentation":"<p>Array of tags to be removed.</p>",
|
||
"location":"querystring",
|
||
"locationName":"tagKeys"
|
||
}
|
||
}
|
||
},
|
||
"UntagResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"UpdateRoomRequest":{
|
||
"type":"structure",
|
||
"required":["identifier"],
|
||
"members":{
|
||
"identifier":{
|
||
"shape":"RoomIdentifier",
|
||
"documentation":"<p>Identifier of the room to be updated. Currently this must be an ARN.</p>"
|
||
},
|
||
"maximumMessageLength":{
|
||
"shape":"RoomMaxMessageLength",
|
||
"documentation":"<p>The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.</p>"
|
||
},
|
||
"maximumMessageRatePerSecond":{
|
||
"shape":"RoomMaxMessageRatePerSecond",
|
||
"documentation":"<p>Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.</p>"
|
||
},
|
||
"messageReviewHandler":{
|
||
"shape":"MessageReviewHandler",
|
||
"documentation":"<p>Configuration information for optional review of messages. Specify an empty <code>uri</code> string to disassociate a message review handler from the specified room.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Room name. The value does not need to be unique.</p>"
|
||
}
|
||
}
|
||
},
|
||
"UpdateRoomResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"arn":{
|
||
"shape":"RoomArn",
|
||
"documentation":"<p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>"
|
||
},
|
||
"createTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
},
|
||
"id":{
|
||
"shape":"RoomID",
|
||
"documentation":"<p>Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.</p>"
|
||
},
|
||
"maximumMessageLength":{
|
||
"shape":"RoomMaxMessageLength",
|
||
"documentation":"<p>Maximum number of characters in a single message, from the request.</p>"
|
||
},
|
||
"maximumMessageRatePerSecond":{
|
||
"shape":"RoomMaxMessageRatePerSecond",
|
||
"documentation":"<p>Maximum number of messages per second that can be sent to the room (by all clients), from the request.</p>"
|
||
},
|
||
"messageReviewHandler":{
|
||
"shape":"MessageReviewHandler",
|
||
"documentation":"<p>Configuration information for optional review of messages.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"RoomName",
|
||
"documentation":"<p>Room name, from the request.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"Tags",
|
||
"documentation":"<p>Tags attached to the resource.</p>"
|
||
},
|
||
"updateTime":{
|
||
"shape":"Time",
|
||
"documentation":"<p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"UserID":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1
|
||
},
|
||
"ValidationException":{
|
||
"type":"structure",
|
||
"required":[
|
||
"message",
|
||
"reason"
|
||
],
|
||
"members":{
|
||
"fieldList":{
|
||
"shape":"ValidationExceptionFieldList",
|
||
"documentation":"<p/>"
|
||
},
|
||
"message":{"shape":"ErrorMessage"},
|
||
"reason":{
|
||
"shape":"ValidationExceptionReason",
|
||
"documentation":"<p/>"
|
||
}
|
||
},
|
||
"documentation":"<p/>",
|
||
"error":{
|
||
"httpStatusCode":400,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"ValidationExceptionField":{
|
||
"type":"structure",
|
||
"required":[
|
||
"message",
|
||
"name"
|
||
],
|
||
"members":{
|
||
"message":{
|
||
"shape":"ErrorMessage",
|
||
"documentation":"<p>Explanation of the reason for the validation error.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"FieldName",
|
||
"documentation":"<p>Name of the field which failed validation.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>This object is used in the ValidationException error.</p>"
|
||
},
|
||
"ValidationExceptionFieldList":{
|
||
"type":"list",
|
||
"member":{"shape":"ValidationExceptionField"}
|
||
},
|
||
"ValidationExceptionReason":{
|
||
"type":"string",
|
||
"enum":[
|
||
"UNKNOWN_OPERATION",
|
||
"FIELD_VALIDATION_FAILED",
|
||
"OTHER"
|
||
]
|
||
}
|
||
},
|
||
"documentation":"<p> <b>Introduction</b> </p> <p>The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html\"> Amazon IVS Chat Messaging API</a>, to enable users to interact with chat rooms in real time.</p> <p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the <a href=\"https://docs.aws.amazon.com/general/latest/gr/ivs.html\">Amazon IVS page</a> in the <i>AWS General Reference</i>. </p> <p> <b>Notes on terminology:</b> </p> <ul> <li> <p>You create service applications using the Amazon IVS Chat API. We refer to these as <i>applications</i>.</p> </li> <li> <p>You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as <i>clients</i>. </p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resource is part of Amazon IVS Chat:</p> <ul> <li> <p> <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.</p> </li> </ul> <p> <b>API Access Security</b> </p> <p>Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.</p> </li> </ul> <p>Users (viewers) connect to a room using secure access tokens that you create using the <a>CreateChatToken</a> endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.</p> <p> <b>Signing API Requests</b> </p> <p>HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.</p> <p>You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the <code>ivschat:DeleteMessage</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html\">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Messaging Endpoints</b> </p> <ul> <li> <p> <a>DeleteMessage</a> — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html\"> DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p> </li> <li> <p> <a>DisconnectUser</a> — Disconnects all connections using a specified user ID from a room. This replicates the <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html\"> DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p> </li> <li> <p> <a>SendEvent</a> — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.</p> </li> </ul> <p> <b>Chat Token Endpoint</b> </p> <ul> <li> <p> <a>CreateChatToken</a> — Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.</p> </li> </ul> <p> <b>Room Endpoints</b> </p> <ul> <li> <p> <a>CreateRoom</a> — Creates a room that allows clients to connect and pass messages.</p> </li> <li> <p> <a>DeleteRoom</a> — Deletes the specified room.</p> </li> <li> <p> <a>GetRoom</a> — Gets the specified room.</p> </li> <li> <p> <a>ListRooms</a> — Gets summary information about all your rooms in the AWS region where the API request is processed. </p> </li> <li> <p> <a>UpdateRoom</a> — Updates a room’s configuration.</p> </li> </ul> <p> <b>Tags Endpoints</b> </p> <ul> <li> <p> <a>ListTagsForResource</a> — Gets information about AWS tags for the specified ARN.</p> </li> <li> <p> <a>TagResource</a> — Adds or updates tags for the AWS resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> </ul> <p>All the above are HTTP operations. There is a separate <i>messaging</i> API for managing Chat resources; see the <a href=\"https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html\"> Amazon IVS Chat Messaging API Reference</a>.</p>"
|
||
}
|