AWS.Tools.ApiGatewayManagementApi

3.3.618.0

AWS.Tools.ApiGatewayManagementApi.dll-Help.xml

<helpItems schema="maml">
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-AGMConnection</name>
      <description>
        <para>Calls the Amazon API Gateway Management API GetConnection API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>AGMConnection</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Get information about the connection with the provided id. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-AGMConnection</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>ConnectionId</name>
          <description>
            <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>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>ConnectionId</name>
        <description>
          <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>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.ApiGatewayManagementApi.Model.GetConnectionResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.ApiGatewayManagementApi.Model.GetConnectionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-AGMConnection.html&amp;tocid=Get-AGMConnection</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Remove-AGMConnection</name>
      <description>
        <para>Calls the Amazon API Gateway Management API DeleteConnection API operation.</para>
      </description>
      <verb>Remove</verb>
      <noun>AGMConnection</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Delete the connection with the provided id. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Remove-AGMConnection</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>ConnectionId</name>
          <description>
            <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>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>ConnectionId</name>
        <description>
          <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>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>None or Amazon.ApiGatewayManagementApi.Model.DeleteConnectionResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet does not generate any output.The service response (type Amazon.ApiGatewayManagementApi.Model.DeleteConnectionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-AGMConnection.html&amp;tocid=Remove-AGMConnection</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Send-AGMDataToConnection</name>
      <description>
        <para>Calls the Amazon API Gateway Management API PostToConnection API operation.</para>
      </description>
      <verb>Send</verb>
      <noun>AGMDataToConnection</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Sends the provided data to the specified connection. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Send-AGMDataToConnection</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>Data</name>
          <description>
            <para>The data to be sent to the client specified by its connection id.
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>
          </description>
          <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue>
        </parameter>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>ConnectionId</name>
          <description>
            <para>The identifier of the connection that a specific client is using. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>ConnectionId</name>
        <description>
          <para>The identifier of the connection that a specific client is using. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>Data</name>
        <description>
          <para>The data to be sent to the client specified by its connection id.
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>
        </description>
        <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue>
        <type>
          <name>System.Byte[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>None or Amazon.ApiGatewayManagementApi.Model.PostToConnectionResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet does not generate any output.The service response (type Amazon.ApiGatewayManagementApi.Model.PostToConnectionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Send-AGMDataToConnection.html&amp;tocid=Send-AGMDataToConnection</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
</helpItems>