AWS.Tools.ApiGatewayManagementApi.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ApiGatewayManagementApi</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AGM.GetAGMConnectionCmdlet"> <summary> Get information about the connection with the provided id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.GetAGMConnectionCmdlet.ConnectionId"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.GetAGMConnectionCmdlet.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.ApiGatewayManagementApi.Model.GetConnectionResponse). Specifying the name of a property of type Amazon.ApiGatewayManagementApi.Model.GetConnectionResponse 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.AGM.GetAGMConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AGM.RemoveAGMConnectionCmdlet"> <summary> Delete the connection with the provided id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.RemoveAGMConnectionCmdlet.ConnectionId"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.RemoveAGMConnectionCmdlet.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.ApiGatewayManagementApi.Model.DeleteConnectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.RemoveAGMConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.RemoveAGMConnectionCmdlet.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.AGM.SendAGMDataToConnectionCmdlet"> <summary> Sends the provided data to the specified connection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.SendAGMDataToConnectionCmdlet.ConnectionId"> <summary> <para> <para>The identifier of the connection that a specific client is using.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.SendAGMDataToConnectionCmdlet.Data"> <summary> <para> <para>The data to be sent to the client specified by its connection id.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.SendAGMDataToConnectionCmdlet.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.ApiGatewayManagementApi.Model.PostToConnectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.SendAGMDataToConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Data parameter. The -PassThru parameter is deprecated, use -Select '^Data' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AGM.SendAGMDataToConnectionCmdlet.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> |