AWS.Tools.Ivschat.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Ivschat</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.AddIVSCResourceTagCmdlet"> <summary> Adds or updates tags for the AWS resource with the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.AddIVSCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be tagged. The ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.AddIVSCResourceTagCmdlet.Tag"> <summary> <para> <para>Array of tags to be added or updated. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.AddIVSCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.AddIVSCResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.DisconnectIVSCUserCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.DisconnectIVSCUserCmdlet.Reason"> <summary> <para> <para>Reason for disconnecting the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.DisconnectIVSCUserCmdlet.RoomIdentifier"> <summary> <para> <para>Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.DisconnectIVSCUserCmdlet.UserId"> <summary> <para> <para>ID of the user (connection) to disconnect from the room.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.DisconnectIVSCUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.DisconnectUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.DisconnectIVSCUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationCmdlet"> <summary> Gets the specified logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationCmdlet.Identifier"> <summary> <para> <para>Identifier of the logging configuration to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.GetLoggingConfigurationResponse). Specifying the name of a property of type Amazon.Ivschat.Model.GetLoggingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationListCmdlet"> <summary> Gets summary information about all your logging configurations in the AWS region where the API request is processed.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of logging configurations to return. Default: 50.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationListCmdlet.NextToken"> <summary> <para> <para>The first logging configurations to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LoggingConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.ListLoggingConfigurationsResponse). Specifying the name of a property of type Amazon.Ivschat.Model.ListLoggingConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCLoggingConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCResourceTagCmdlet"> <summary> Gets information about AWS tags for the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Ivschat.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomCmdlet"> <summary> Gets the specified room. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomCmdlet.Identifier"> <summary> <para> <para>Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.GetRoomResponse). Specifying the name of a property of type Amazon.Ivschat.Model.GetRoomResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet"> <summary> Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of <c>updateTime</c>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.LoggingConfigurationIdentifier"> <summary> <para> <para>Logging-configuration identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.MessageReviewHandlerUri"> <summary> <para> <para>Filters the list to match the specified message review handler URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.Name"> <summary> <para> <para>Filters the list to match the specified room name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of rooms to return. Default: 50.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.NextToken"> <summary> <para> <para>The first room to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Rooms'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.ListRoomsResponse). Specifying the name of a property of type Amazon.Ivschat.Model.ListRoomsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.GetIVSCRoomListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet"> <summary> Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response. <para> Use the <c>capabilities</c> field to permit an end user to send messages or moderate a room. </para><para> The <c>attributes</c> field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features. </para><para> Encryption keys are owned by Amazon IVS Chat and never used directly by your application. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.Attribute"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.Capability"> <summary> <para> <para>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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.RoomIdentifier"> <summary> <para> <para>Identifier of the room that the client is trying to access. Currently this must be an ARN. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.SessionDurationInMinute"> <summary> <para> <para>Session duration (in minutes), after which the session expires. Default: 60 (1 hour).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.UserId"> <summary> <para> <para>Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.CreateChatTokenResponse). Specifying the name of a property of type Amazon.Ivschat.Model.CreateChatTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCChatTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet"> <summary> Creates a logging configuration that allows clients to store and record sent messages. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.S3_BucketName"> <summary> <para> <para>Name of the Amazon S3 bucket where chat activity will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.Firehose_DeliveryStreamName"> <summary> <para> <para>Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.CloudWatchLogs_LogGroupName"> <summary> <para> <para>Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.Name"> <summary> <para> <para>Logging-configuration name. The value does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.Tag"> <summary> <para> <para>Tags to attach to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.CreateLoggingConfigurationResponse). Specifying the name of a property of type Amazon.Ivschat.Model.CreateLoggingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCLoggingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet"> <summary> Creates a room that allows clients to connect and pass messages. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.MessageReviewHandler_FallbackResult"> <summary> <para> <para>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: <c>ALLOW</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.LoggingConfigurationIdentifier"> <summary> <para> <para>Array of logging-configuration identifiers attached to the room.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.MaximumMessageLength"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.MaximumMessageRatePerSecond"> <summary> <para> <para>Maximum number of messages per second that can be sent to the room (by all clients). Default: 10. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.Name"> <summary> <para> <para>Room name. The value does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.Tag"> <summary> <para> <para>Tags to attach to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.MessageReviewHandler_Uri"> <summary> <para> <para>Identifier of the message review handler. Currently this must be an ARN of a lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.CreateRoomResponse). Specifying the name of a property of type Amazon.Ivschat.Model.CreateRoomResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.NewIVSCRoomCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCLoggingConfigurationCmdlet"> <summary> Deletes the specified logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCLoggingConfigurationCmdlet.Identifier"> <summary> <para> <para>Identifier of the logging configuration to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.DeleteLoggingConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCLoggingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCMessageCmdlet"> <summary> 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 <c>EventName</c> is <c>aws:DELETE_MESSAGE</c>. 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCMessageCmdlet.Id"> <summary> <para> <para>ID of the message to be deleted. This is the <c>Id</c> 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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCMessageCmdlet.Reason"> <summary> <para> <para>Reason for deleting the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCMessageCmdlet.RoomIdentifier"> <summary> <para> <para>Identifier of the room where the message should be deleted. Currently this must be an ARN. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.DeleteMessageResponse). Specifying the name of a property of type Amazon.Ivschat.Model.DeleteMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCResourceTagCmdlet"> <summary> Removes tags from the resource with the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be untagged. The ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCResourceTagCmdlet.TagKey"> <summary> <para> <para>Array of tags to be removed. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCRoomCmdlet"> <summary> Deletes the specified room. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCRoomCmdlet.Identifier"> <summary> <para> <para>Identifier of the room to be deleted. Currently this must be an ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCRoomCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.DeleteRoomResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.RemoveIVSCRoomCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.SendIVSCEventCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.SendIVSCEventCmdlet.Attribute"> <summary> <para> <para>Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.SendIVSCEventCmdlet.EventName"> <summary> <para> <para>Application-defined name of the event to send to clients.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.SendIVSCEventCmdlet.RoomIdentifier"> <summary> <para> <para>Identifier of the room to which the event will be sent. Currently this must be an ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.SendIVSCEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.SendEventResponse). Specifying the name of a property of type Amazon.Ivschat.Model.SendEventResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.SendIVSCEventCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet"> <summary> Updates a specified logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.S3_BucketName"> <summary> <para> <para>Name of the Amazon S3 bucket where chat activity will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.Firehose_DeliveryStreamName"> <summary> <para> <para>Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.Identifier"> <summary> <para> <para>Identifier of the logging configuration to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.CloudWatchLogs_LogGroupName"> <summary> <para> <para>Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.Name"> <summary> <para> <para>Logging-configuration name. The value does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.UpdateLoggingConfigurationResponse). Specifying the name of a property of type Amazon.Ivschat.Model.UpdateLoggingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCLoggingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet"> <summary> Updates a room’s configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.MessageReviewHandler_FallbackResult"> <summary> <para> <para>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: <c>ALLOW</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.Identifier"> <summary> <para> <para>Identifier of the room to be updated. Currently this must be an ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.LoggingConfigurationIdentifier"> <summary> <para> <para>Array of logging-configuration identifiers attached to the room.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.MaximumMessageLength"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.MaximumMessageRatePerSecond"> <summary> <para> <para>Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.Name"> <summary> <para> <para>Room name. The value does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.MessageReviewHandler_Uri"> <summary> <para> <para>Identifier of the message review handler. Currently this must be an ARN of a lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.UpdateRoomResponse). Specifying the name of a property of type Amazon.Ivschat.Model.UpdateRoomResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSC.UpdateIVSCRoomCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |